redsnow 0.2.0 → 0.2.1

data/ext/snowcrash/src/CBlueprintSourcemap.h

@@ -0,0 +1,342 @@
+//
+//  CBlueprintSourcemap.h
+//  snowcrash
+//  C Implementation of BlueprintSourcemap.h for binding purposes
+//
+//  Created by Pavan Kumar Sunkara on 12/9/14.
+//  Copyright (c) 2014 Apiary Inc. All rights reserved.
+//
+
+#ifndef SC_C_BLUEPRINT_SOURCEMAP_H
+#define SC_C_BLUEPRINT_SOURCEMAP_H
+
+#include "Platform.h"
+#include "stdlib.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+    /** Class source map wrapper */
+    struct sc_source_map_s;
+    typedef struct sc_source_map_s sc_source_map_t;
+
+    /** Class Blueprint source map wrapper */
+    struct sc_sm_blueprint_s;
+    typedef struct sc_sm_blueprint_s sc_sm_blueprint_t;
+
+    /** Array Metadata source map wrapper */
+    struct sc_sm_metadata_collection_s;
+    typedef struct sc_sm_metadata_collection_s sc_sm_metadata_collection_t;
+
+    /** Class Metadata source map wrapper */
+    struct sc_sm_metadata_s;
+    typedef struct sc_sm_metadata_s sc_sm_metadata_t;
+
+    /** Array Resource Group Collection source map wrapper */
+    struct sc_sm_resource_group_collection_s;
+    typedef struct sc_sm_resource_group_collection_s sc_sm_resource_group_collection_t;
+
+    /** Class Resource Group source map wrapper */
+    struct sc_sm_resource_group_s;
+    typedef struct sc_sm_resource_group_s sc_sm_resource_group_t;
+
+    /** Array Resource Collection source map wrapper */
+    struct sc_sm_resource_collection_s;
+    typedef struct sc_sm_resource_collection_s sc_sm_resource_collection_t;
+
+    /** Class Resource source map wrapper */
+    struct sc_sm_resource_s;
+    typedef struct sc_sm_resource_s sc_sm_resource_t;
+
+    /** Class Resource Model source map wrapper */
+    struct sc_sm_resource_model_s;
+    typedef struct sc_sm_resource_model_s sc_sm_resource_model_t;
+
+    /** Array Payload Collection source map wrapper */
+    struct sc_sm_payload_collection_s;
+    typedef struct sc_sm_payload_collection_s sc_sm_payload_collection_t;
+
+    /** Class Payload source map wrapper */
+    struct sc_sm_payload_s;
+    typedef struct sc_sm_payload_s sc_sm_payload_t;
+
+    /** Array Parameter source map wrapper */
+    struct sc_sm_parameter_collection_s;
+    typedef struct sc_sm_parameter_collection_s sc_sm_parameter_collection_t;
+
+    /** class Parameter source map wrapper */
+    struct sc_sm_parameter_s;
+    typedef struct sc_sm_parameter_s sc_sm_parameter_t;
+
+    /** Array Header source map wrapper */
+    struct sc_sm_header_collection_s;
+    typedef struct sc_sm_header_collection_s sc_sm_header_collection_t;
+
+    /** class Header source map wrapper */
+    struct sc_sm_header_s;
+    typedef struct sc_sm_header_s sc_sm_header_t;
+
+    /** Array Value source map wrapper */
+    struct sc_sm_value_collection_s;
+    typedef struct sc_sm_value_collection_s sc_sm_value_collection_t;
+
+    /** class Value source map wrapper */
+    struct sc_sm_value_s;
+    typedef struct sc_sm_value_s sc_sm_value_t;
+
+    /** Array Action source map wrapper */
+    struct sc_sm_action_collection_s;
+    typedef struct sc_sm_action_collection_s sc_sm_action_collection_t;
+
+    /** class Action source map wrapper */
+    struct sc_sm_action_s;
+    typedef struct sc_sm_action_s sc_sm_action_t;
+
+    /** Array Transaction Example source map wrapper */
+    struct sc_sm_transaction_example_collection_s;
+    typedef struct sc_sm_transaction_example_collection_s sc_sm_transaction_example_collection_t;
+
+    /** class Transaction Example source map wrapper */
+    struct sc_sm_transaction_example_s;
+    typedef struct sc_sm_transaction_example_s sc_sm_transaction_example_t;
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns size of the source map */
+    SC_API size_t sc_source_map_size(const sc_source_map_t* source_map);
+
+    /** \returns Location of the source map item at index */
+    SC_API size_t sc_source_map_length(const sc_source_map_t* source_map, size_t index);
+
+    /** \returns Length of the source map item at index */
+    SC_API size_t sc_source_map_location(const sc_source_map_t* source_map, size_t index);
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns pointer to allocated Blueprint source map */
+    SC_API sc_sm_blueprint_t* sc_sm_blueprint_new();
+
+    /** \deallocate Blueprint source map from pointer */
+    SC_API void sc_sm_blueprint_free(sc_sm_blueprint_t* blueprint);
+
+    /** \returns Blueprint name source map */
+    SC_API const sc_source_map_t* sc_sm_blueprint_name(const sc_sm_blueprint_t* blueprint);
+
+    /** \returns Blueprint description source map */
+    SC_API const sc_source_map_t* sc_sm_blueprint_description(const sc_sm_blueprint_t* blueprint);
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns Metadata source map array handle */
+    SC_API const sc_sm_metadata_collection_t* sc_sm_metadata_collection_handle(const sc_sm_blueprint_t* blueprint);
+
+    /** \returns size of Metadata source map array */
+    SC_API size_t sc_sm_metadata_collection_size(const sc_sm_metadata_collection_t* metadata);
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns Metadata source map at `index` handle */
+    SC_API const sc_sm_metadata_t* sc_sm_metadata_handle(const sc_sm_metadata_collection_t* metadata_col, size_t index);
+
+    /** \returns Metadata source map */
+    SC_API const sc_source_map_t* sc_sm_metadata(const sc_sm_metadata_t* metadata);
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns Resource Group Collection source map array handle */
+    SC_API const sc_sm_resource_group_collection_t* sc_sm_resource_group_collection_handle(const sc_sm_blueprint_t* blueprint);
+
+    /** \returns size of Resource Group Collection source map array */
+    SC_API size_t sc_sm_resource_group_collection_size(const sc_sm_resource_group_collection_t* resource);
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns Resource Group source map handle */
+    SC_API const sc_sm_resource_group_t* sc_sm_resource_group_handle(const sc_sm_resource_group_collection_t* resource, size_t index);
+
+    /** \returns Resource Group name source map */
+    SC_API const sc_source_map_t* sc_sm_resource_group_name(const sc_sm_resource_group_t* handle);
+
+    /** \returns Resource Group description source map */
+    SC_API const sc_source_map_t* sc_sm_resource_group_description(const sc_sm_resource_group_t* handle);
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns Resource source map array handle */
+    SC_API const sc_sm_resource_collection_t* sc_sm_resource_collection_handle(const sc_sm_resource_group_t* handle);
+
+    /** \returns Resource source map array size */
+    SC_API size_t sc_sm_resource_collection_size(const sc_sm_resource_collection_t* resource);
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns Resource source map handle */
+    SC_API const sc_sm_resource_t* sc_sm_resource_handle(const sc_sm_resource_collection_t* resource, size_t index);
+
+    /** \returns Resource URITemplate source map */
+    SC_API const sc_source_map_t* sc_sm_resource_uritemplate(const sc_sm_resource_t* handle);
+
+    /** \returns Resource name source map */
+    SC_API const sc_source_map_t* sc_sm_resource_name(const sc_sm_resource_t* handle);
+
+    /** \returns Resource description source map */
+    SC_API const sc_source_map_t* sc_sm_resource_description(const sc_sm_resource_t* handle);
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns Payload Collection source map array handle from TransactionExample for requests*/
+    SC_API const sc_sm_payload_collection_t* sc_sm_payload_collection_handle_requests(const sc_sm_transaction_example_t* handle);
+
+    /** \returns Payload Collection source map array handle from TransactionExample for responses*/
+    SC_API const sc_sm_payload_collection_t* sc_sm_payload_collection_handle_responses(const sc_sm_transaction_example_t* handle);
+
+    /** \returns Payload Collection array size */
+    SC_API size_t sc_sm_payload_collection_size(const sc_sm_payload_collection_t* handle);
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns Payload source map at `index` handle */
+    SC_API const sc_sm_payload_t* sc_sm_payload_handle(const sc_sm_payload_collection_t* handle, size_t index);
+
+    /** \returns Payload source map handle from resource source map */
+    SC_API const sc_sm_payload_t* sc_sm_payload_handle_resource(const sc_sm_resource_t* handle);
+
+    /** \returns Payload name source map */
+    SC_API const sc_source_map_t* sc_sm_payload_name(const sc_sm_payload_t* handle);
+
+    /** \returns Payload symbol name source map */
+    SC_API const sc_source_map_t* sc_sm_payload_symbol(const sc_sm_payload_t* handle);
+
+    /** \returns Payload description source map */
+    SC_API const sc_source_map_t* sc_sm_payload_description(const sc_sm_payload_t* handle);
+
+    /** \returns Payload body source map */
+    SC_API const sc_source_map_t* sc_sm_payload_body(const sc_sm_payload_t* handle);
+
+    /** \returns Payload schema source map */
+    SC_API const sc_source_map_t* sc_sm_payload_schema(const sc_sm_payload_t* handle);
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns Parameter Collection source map array handle from Payload source map */
+    SC_API const sc_sm_parameter_collection_t* sc_sm_parameter_collection_handle_payload(const sc_sm_payload_t* handle);
+
+    /** \returns Parameter Collection source map array handle from Resource source map */
+    SC_API const sc_sm_parameter_collection_t* sc_sm_parameter_collection_handle_resource(const sc_sm_resource_t* handle);
+
+    /** \returns Parameter Collection source map array handle from Action source map */
+    SC_API const sc_sm_parameter_collection_t* sc_sm_parameter_collection_handle_action(const sc_sm_action_t* handle);
+
+    /** \returns Parameter Collection source map array size */
+    SC_API size_t sc_sm_parameter_collection_size(const sc_sm_parameter_collection_t* handle);
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns Parameter source map handle */
+    SC_API const sc_sm_parameter_t* sc_sm_parameter_handle(const sc_sm_parameter_collection_t* handle, size_t index);
+
+    /** \returns Parameter name source map */
+    SC_API const sc_source_map_t* sc_sm_parameter_name(const sc_sm_parameter_t* handle);
+
+    /** \returns Parameter description source map */
+    SC_API const sc_source_map_t* sc_sm_parameter_description(const sc_sm_parameter_t* handle);
+
+    /** \returns Parameter type source map */
+    SC_API const sc_source_map_t* sc_sm_parameter_type(const sc_sm_parameter_t* handle);
+
+    /** \returns Parameter use source map */
+    SC_API const sc_source_map_t* sc_sm_parameter_parameter_use(const sc_sm_parameter_t* handle);
+
+    /** \returns Parameter default value source map */
+    SC_API const sc_source_map_t* sc_sm_parameter_default_value(const sc_sm_parameter_t* handle);
+
+    /** \returns Parameter example value source map */
+    SC_API const sc_source_map_t* sc_sm_parameter_example_value(const sc_sm_parameter_t* handle);
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns Value Collection source map array handle */
+    SC_API const sc_sm_value_collection_t* sc_sm_value_collection_handle(const sc_sm_parameter_t* handle);
+
+    /** \returns Value Collection source map array size */
+    SC_API size_t sc_sm_value_collection_size(const sc_sm_value_collection_t* handle);
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns Value source map handle */
+    SC_API const sc_sm_value_t* sc_sm_value_handle(const sc_sm_value_collection_t* handle, size_t index);
+
+    /** \returns Value source map */
+    SC_API const sc_source_map_t* sc_sm_value(const sc_sm_value_t* handle);
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns Header Collection source map array handle from Payload source map */
+    SC_API const sc_sm_header_collection_t* sc_sm_header_collection_handle_payload(const sc_sm_payload_t* handle);
+
+    /** \returns Header Collection source map array handle from Resource source map */
+    SC_API const sc_sm_header_collection_t* sc_sm_header_collection_handle_resource(const sc_sm_resource_t* handle);
+
+    /** \returns Header Collection source map array handle from Action source map */
+    SC_API const sc_sm_header_collection_t* sc_sm_header_collection_handle_action(const sc_sm_action_t* handle);
+
+    /** \returns Header Collection source map array size */
+    SC_API size_t sc_sm_header_collection_size(const sc_sm_header_collection_t* handle);
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns Header source map handle */
+    SC_API const sc_sm_header_t* sc_sm_header_handle(const sc_sm_header_collection_t* handle, size_t index);
+
+    /** \returns Header source map */
+    SC_API const sc_source_map_t* sc_sm_header(const sc_sm_header_t* handle);
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns Action Collection source map array handle */
+    SC_API const sc_sm_action_collection_t* sc_sm_action_collection_handle(const sc_sm_resource_t* handle);
+
+    /** \returns Action Collection source map array size */
+    SC_API size_t sc_sm_action_collection_size(const sc_sm_action_collection_t* handle);
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns Action source map handle */
+    SC_API const sc_sm_action_t* sc_sm_action_handle(const sc_sm_action_collection_t* handle, size_t index);
+
+    /** \returns Action HTTPMethod source map */
+    SC_API const sc_source_map_t* sc_sm_action_httpmethod(const sc_sm_action_t* handle);
+
+    /** \returns Action name source map */
+    SC_API const sc_source_map_t* sc_sm_action_name(const sc_sm_action_t* handle);
+
+    /** \returns Action description source map */
+    SC_API const sc_source_map_t* sc_sm_action_description(const sc_sm_action_t* handle);
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns Transaction Example Collection source map array handle */
+    SC_API const sc_sm_transaction_example_collection_t* sc_sm_transaction_example_collection_handle(const sc_sm_action_t* handle);
+
+    /** \returns Transaction Example Collection source map array size */
+    SC_API size_t sc_sm_transaction_example_collection_size(const sc_sm_transaction_example_collection_t* handle);
+
+    /*----------------------------------------------------------------------*/
+
+    /** \returns Transaction Example source map handle */
+    SC_API const sc_sm_transaction_example_t* sc_sm_transaction_example_handle(const sc_sm_transaction_example_collection_t* handle, size_t index);
+
+    /** \returns Transaction Example name source map */
+    SC_API const sc_source_map_t* sc_sm_transaction_example_name(const sc_sm_transaction_example_t* handle);
+
+    /** \returns Transaction Example description source map */
+    SC_API const sc_source_map_t* sc_sm_transaction_example_description(const sc_sm_transaction_example_t* handle);
+
+    /*----------------------------------------------------------------------*/
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

data/ext/snowcrash/src/CSourceAnnotation.cc

@@ -28,6 +28,7 @@ SC_API const sc_location_t* sc_location_handler(const sc_source_annotation_t* so
     const snowcrash::SourceAnnotation* p = AS_CTYPE(snowcrash::SourceAnnotation, source);
     if(!p)
         return NULL;
+
     return AS_CTYPE(sc_location_t, &p->location);
 }
 
@@ -36,6 +37,7 @@ SC_API size_t sc_location_size(const sc_location_t* location)
     const mdp::CharactersRangeSet* p = AS_CTYPE(mdp::CharactersRangeSet, location);
     if(!p)
         return 0;
+
     return p->size();
 }
 
@@ -44,6 +46,7 @@ SC_API size_t sc_location_length(const sc_location_t* location, size_t index)
     const mdp::CharactersRangeSet* p = AS_CTYPE(mdp::CharactersRangeSet, location);
     if(!p)
         return 0;
+
     return p->at(index).length;
 }
 
@@ -52,6 +55,7 @@ SC_API size_t sc_location_location(const sc_location_t* location, size_t index)
     const mdp::CharactersRangeSet* p = AS_CTYPE(mdp::CharactersRangeSet, location);
     if(!p)
         return 0;
+
     return p->at(index).location;
 }
 
@@ -62,6 +66,7 @@ SC_API const sc_error_t* sc_error_handler(const sc_report_t* report)
     const snowcrash::Report* p = AS_CTYPE(snowcrash::Report, report);
     if(!p)
         return NULL;
+
     return AS_CTYPE(sc_error_t, &p->error);
 }
 
@@ -70,6 +75,7 @@ SC_API const char* sc_error_message(const sc_error_t* error)
     const snowcrash::Error* p = AS_CTYPE(snowcrash::Error, error);
     if (!p)
         return "";
+
     return p->message.c_str();
 }
 
@@ -78,6 +84,7 @@ SC_API int sc_error_code(const sc_error_t* error)
     const snowcrash::Error* p = AS_CTYPE(snowcrash::Error, error);
     if (!p)
         return 0;
+
     return p->code;
 }
 
@@ -86,6 +93,7 @@ SC_API int sc_error_ok(const sc_error_t* error)
     const snowcrash::Error* p = AS_CTYPE(snowcrash::Error, error);
     if (!p)
         return 0;
+
     return p->OK;
 }
 
@@ -96,6 +104,7 @@ SC_API const sc_warnings_t* sc_warnings_handler(const sc_report_t* report)
     const snowcrash::Report* p = AS_CTYPE(snowcrash::Report, report);
     if(!p)
         return NULL;
+
     return AS_CTYPE(sc_warnings_t, &p->warnings);
 }
 
@@ -104,6 +113,7 @@ SC_API size_t sc_warnings_size(const sc_warnings_t* warning)
     const snowcrash::Warnings* p = AS_CTYPE(snowcrash::Warnings, warning);
     if(!p)
         return 0;
+
     return p->size();
 }
 
@@ -112,6 +122,7 @@ SC_API const sc_warning_t* sc_warning_handler(const sc_warnings_t* warning, size
     const snowcrash::Warnings* p = AS_CTYPE(snowcrash::Warnings, warning);
     if(!p)
         return NULL;
+
     return AS_CTYPE(sc_warning_t, &p->at(index));
 }
 
@@ -120,6 +131,7 @@ SC_API const char* sc_warning_message(const sc_warning_t* warning)
     const snowcrash::Warning* p = AS_CTYPE(snowcrash::Warning, warning);
     if (!p)
         return "";
+
     return p->message.c_str();
 }
 
@@ -128,6 +140,7 @@ SC_API int sc_warning_code(const sc_warning_t* warning)
     const snowcrash::Warning* p = AS_CTYPE(snowcrash::Warning, warning);
     if (!p)
         return 0;
+
     return p->code;
 }
 
@@ -136,5 +149,6 @@ SC_API int sc_warning_ok(const sc_warning_t* warning)
     const snowcrash::Warning* p = AS_CTYPE(snowcrash::Warning, warning);
     if (!p)
         return 0;
+
     return p->OK;
 }

data/ext/snowcrash/src/CodeBlockUtility.h

@@ -55,6 +55,8 @@ namespace snowcrash {
                                        const SectionParserData& pd,
                                        Report& report,
                                        mdp::ByteBuffer& content) {
+
+            checkPossibleReference(node, pd, report);
             
             if (node->type == mdp::CodeMarkdownNodeType) {
                 content += node->text;
@@ -197,12 +199,14 @@ namespace snowcrash {
         /**
          *  \brief Add dangling message body asset to the given string
          *  \param  out  The string to which the dangling asset should be added
+         *  \param  outSM The source map to which source map should be added
+         *  \return asset The value of the asset
          */
-        static void addDanglingAsset(const MarkdownNodeIterator& node,
-                                     SectionParserData& pd,
-                                     SectionType& sectionType,
-                                     Report& report,
-                                     mdp::ByteBuffer& out) {
+        static mdp::ByteBuffer addDanglingAsset(const MarkdownNodeIterator& node,
+                                                SectionParserData& pd,
+                                                SectionType& sectionType,
+                                                Report& report,
+                                                mdp::ByteBuffer& out) {
 
             mdp::ByteBuffer asset;
 
@@ -220,6 +224,7 @@ namespace snowcrash {
             if (node->type == mdp::CodeMarkdownNodeType)
                 level--;  // Deduct one level for a code block
 
+            checkPossibleReference(node, pd, report);
                 
             if (level) {
                 // WARN: Dangling asset
@@ -232,6 +237,38 @@ namespace snowcrash {
                                                   IndentationWarning,
                                                   sourceMap));
             }
+
+            return asset;
+        }
+
+        /**
+         *  \brief Check for potential resource model reference and warn about not recognizing them
+         *  \return True if code block contains a resource model reference, false otherwise.
+         */
+        static bool checkPossibleReference(const MarkdownNodeIterator& node,
+                                           const SectionParserData& pd,
+                                           Report& report) {
+
+            mdp::ByteBuffer source = node->text;
+            SymbolName symbol;
+
+            TrimString(source);
+
+            if(GetSymbolReference(source, symbol)) {
+
+                std::stringstream ss;
+                ss << "found a possible '" << symbol << "' model reference, ";
+                ss << "a reference must be directly in the " << SectionName(pd.sectionContext()) << " section, indented by 4 spaces or 1 tab, without any additional sections";
+
+                mdp::CharactersRangeSet sourceMap = mdp::BytesRangeSetToCharactersRangeSet(node->sourceMap, pd.sourceData);
+                report.warnings.push_back(Warning(ss.str(),
+                                                  IgnoringWarning,
+                                                  sourceMap));
+
+                return true;
+            }
+
+            return false;
         }
     };
 }