redsnow 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee23a2d43da39feb6ca4e0238652fb4ab3233975
-  data.tar.gz: b9f182cffddcd81c49b515c8b033f4d84f7a3f64
+  metadata.gz: 95878106472075ff91ed563622ec6285529c0530
+  data.tar.gz: dc6cda45a08da74637a36db527bff272491c24d0
 SHA512:
-  metadata.gz: 0d6f68de2038028753baffa195aeea9e85d4cf020a3013a330259ca467009b1af0423642bd2464278198a50002edaae6752c8a16d78fe0a431f23fbfb819f848
-  data.tar.gz: dc19e0bee08bb8dfc73433a916c2155674ffd048ac231d38aebb4a947e8ab66619f1178659ccc9ebddff4b5428dd45101985f4a91d45379bd36a710e6986c05f
+  metadata.gz: 1c9c951c99b4fa2062b8d5673f2567a830e078e77549889924804cb4af80583c532c5f555299fb6a0dee424afd7ffd7a772ea3419f50d9e79b34a80002316eb3
+  data.tar.gz: 43dd575341b35f7f7f02b3603d69e60afe543322c4d903b8259a6c808028cf4bd922dc9a756f3f4de9abefebfa6d7c057675c9fa9c4bd363b11a3a4f3bdc70ce

data/CHANGELOG.md

@@ -1,4 +1,6 @@
 # Changelog
+- 0.3.0
+    - [Format 1A7](https://github.com/apiaryio/api-blueprint/releases/tag/format-1A7) support. [Snow Crash v0.16.0](https://github.com/apiaryio/snowcrash/releases/tag/v0.16.0)
 - 0.2.1
     - Support for source maps [Snow Crash v0.15.0](https://github.com/apiaryio/snowcrash/releases/tag/v0.15.0) and [AST Serialization Format 2.1](https://github.com/apiaryio/api-blueprint-ast/releases/tag/v2.1).
 - 0.2.0

data/ext/snowcrash/snowcrash.xcworkspace/contents.xcworkspacedata

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Workspace
+   version = "1.0">
+   <FileRef
+      location = "group:ext/markdown-parser/markdownparser.xcodeproj">
+   </FileRef>
+   <FileRef
+      location = "group:snowcrash.xcodeproj">
+   </FileRef>
+</Workspace>

data/ext/snowcrash/src/ActionParser.h

@@ -25,7 +25,7 @@ namespace snowcrash {
 
     /** Internal type alias for Collection iterator of Action */
     typedef Collection<Action>::const_iterator ActionIterator;
-    
+
     /** Action Definition Type */
     enum ActionType {
         NotActionType = 0,
@@ -44,7 +44,7 @@ namespace snowcrash {
                                                      const MarkdownNodes& siblings,
                                                      SectionParserData& pd,
                                                      SectionLayout& layout,
-                                                     ParseResult<Action>& out) {
+                                                     const ParseResultRef<Action>& out) {
 
             actionHTTPMethodAndName(node, out.node.method, out.node.name);
             TrimString(out.node.name);
@@ -76,7 +76,7 @@ namespace snowcrash {
         static MarkdownNodeIterator processNestedSection(const MarkdownNodeIterator& node,
                                                          const MarkdownNodes& siblings,
                                                          SectionParserData& pd,
-                                                         ParseResult<Action>& out) {
+                                                         const ParseResultRef<Action>& out) {
 
             SectionType sectionType = pd.sectionContext();
             MarkdownNodeIterator cur = node;
@@ -87,14 +87,15 @@ namespace snowcrash {
             switch (sectionType) {
                 case ParametersSectionType:
                 {
-                    ParseResult<Parameters> parameters(out.report, out.node.parameters, out.sourceMap.parameters);
+                    ParseResultRef<Parameters> parameters(out.report, out.node.parameters, out.sourceMap.parameters);
                     return ParametersParser::parse(node, siblings, pd, parameters);
                 }
 
                 case RequestSectionType:
                 case RequestBodySectionType:
                 {
-                    ParseResult<Payload> payload(out.report);
+                    IntermediateParseResult<Payload> payload(out.report);
+
                     cur = PayloadParser::parse(node, siblings, pd, payload);
 
                     if (out.node.examples.empty() || !out.node.examples.back().responses.empty()) {
@@ -122,7 +123,8 @@ namespace snowcrash {
                 case ResponseSectionType:
                 case ResponseBodySectionType:
                 {
-                    ParseResult<Payload> payload(out.report);
+                    IntermediateParseResult<Payload> payload(out.report);
+
                     cur = PayloadParser::parse(node, siblings, pd, payload);
 
                     if (out.node.examples.empty()) {
@@ -149,7 +151,7 @@ namespace snowcrash {
 
                 case HeadersSectionType:
                 {
-                    ParseResult<Headers> headers(out.report, out.node.headers, out.sourceMap.headers);
+                    ParseResultRef<Headers> headers(out.report, out.node.headers, out.sourceMap.headers);
                     return SectionProcessor<Action>::handleDeprecatedHeaders(node, siblings, pd, headers);
                 }
 
@@ -162,19 +164,19 @@ namespace snowcrash {
 
         static bool isUnexpectedNode(const MarkdownNodeIterator& node,
                                      SectionType sectionType) {
-            
+
             if (SectionProcessor<Asset>::sectionType(node) != UndefinedSectionType) {
                 return true;
             }
-            
+
             return SectionProcessorBase<Action>::isUnexpectedNode(node, sectionType);
         }
-        
+
         static MarkdownNodeIterator processUnexpectedNode(const MarkdownNodeIterator& node,
                                                           const MarkdownNodes& siblings,
                                                           SectionParserData& pd,
                                                           SectionType& sectionType,
-                                                          ParseResult<Action>& out) {
+                                                          const ParseResultRef<Action>& out) {
 
             if ((node->type == mdp::ParagraphMarkdownNodeType ||
                  node->type == mdp::CodeMarkdownNodeType) &&
@@ -191,14 +193,14 @@ namespace snowcrash {
 
                 return ++MarkdownNodeIterator(node);
             }
-            
+
             if ((node->type == mdp::ParagraphMarkdownNodeType ||
                  node->type == mdp::CodeMarkdownNodeType) &&
                 (sectionType == RequestBodySectionType ||
                  sectionType == RequestSectionType) &&
                 !out.node.examples.empty() &&
                 !out.node.examples.back().requests.empty()) {
-                
+
                 mdp::ByteBuffer content = CodeBlockUtility::addDanglingAsset(node, pd, sectionType, out.report, out.node.examples.back().requests.back().body);
 
                 if (pd.exportSourceMap() && !content.empty()) {
@@ -207,15 +209,15 @@ namespace snowcrash {
 
                 return ++MarkdownNodeIterator(node);
             }
-            
+
             SectionType assetType = SectionProcessor<Asset>::sectionType(node);
-            
+
             if (assetType != UndefinedSectionType) {
-                
+
                 // WARN: Ignoring section
                 std::stringstream ss;
                 mdp::CharactersRangeSet sourceMap = mdp::BytesRangeSetToCharactersRangeSet(node->sourceMap, pd.sourceData);
-                
+
                 ss << "Ignoring " << SectionName(assetType) << " list item, ";
                 ss << SectionName(assetType) << " list item is expected to be indented by 4 spaces or 1 tab";
 
@@ -225,8 +227,8 @@ namespace snowcrash {
 
                 return ++MarkdownNodeIterator(node);
             }
-            
-            return SectionProcessorBase<Action>::processUnexpectedNode(node, siblings, pd, sectionType, out);            
+
+            return SectionProcessorBase<Action>::processUnexpectedNode(node, siblings, pd, sectionType, out);
         }
 
         static SectionType sectionType(const MarkdownNodeIterator& node) {
@@ -292,7 +294,7 @@ namespace snowcrash {
 
         static void finalize(const MarkdownNodeIterator& node,
                              SectionParserData& pd,
-                             ParseResult<Action>& out) {
+                             const ParseResultRef<Action>& out) {
 
             if (!out.node.headers.empty()) {
 
@@ -343,7 +345,7 @@ namespace snowcrash {
         static void checkPayload(SectionType sectionType,
                                  const mdp::CharactersRangeSet sourceMap,
                                  const Payload& payload,
-                                 ParseResult<Action>& out) {
+                                 const ParseResultRef<Action>& out) {
 
             if (isPayloadDuplicate(sectionType, payload, out.node.examples.back())) {
 
@@ -418,7 +420,7 @@ namespace snowcrash {
         static MarkdownNodeIterator handleDeprecatedHeaders(const MarkdownNodeIterator& node,
                                                             const MarkdownNodes& siblings,
                                                             SectionParserData& pd,
-                                                            ParseResult<Headers>& out) {
+                                                            const ParseResultRef<Headers>& out) {
 
             MarkdownNodeIterator cur = HeadersParser::parse(node, siblings, pd, out);
 
@@ -433,23 +435,23 @@ namespace snowcrash {
 
             return cur;
         }
-        
+
         /** \return %ActionType of a node */
         static ActionType actionType(const MarkdownNodeIterator& node) {
-            
+
             if (node->type != mdp::HeaderMarkdownNodeType || node->text.empty())
                 return NotActionType;
-                
+
             mdp::ByteBuffer subject = node->text;
             TrimString(subject);
-            
+
             if (RegexMatch(subject, NamedActionHeaderRegex)) {
                 return DependentActionType;
             }
-            
+
             CaptureGroups captureGroups;
             if (RegexCapture(subject, ActionHeaderRegex, captureGroups, 3)) {
-                
+
                 if (captureGroups[2].empty()) {
                     return DependentActionType;
                 }
@@ -457,7 +459,7 @@ namespace snowcrash {
                     return CompleteActionType;
                 }
             }
-            
+
             return NotActionType;
         }
 
@@ -465,20 +467,20 @@ namespace snowcrash {
         static void actionHTTPMethodAndName(const MarkdownNodeIterator& node,
                                             mdp::ByteBuffer& method,
                                             mdp::ByteBuffer& name) {
-            
+
             CaptureGroups captureGroups;
             mdp::ByteBuffer subject, remaining;
-            
+
             subject = GetFirstLine(node->text, remaining);
             TrimString(subject);
-            
+
             if (RegexCapture(subject, ActionHeaderRegex, captureGroups, 3)) {
                 method = captureGroups[1];
             } else if (RegexCapture(subject, NamedActionHeaderRegex, captureGroups, 3)) {
                 name = captureGroups[1];
                 method = captureGroups[2];
             }
-            
+
             return;
         }
 

data/ext/snowcrash/src/AssetParser.h

@@ -14,7 +14,7 @@
 #include "CodeBlockUtility.h"
 
 namespace snowcrash {
-    
+
     /// Asset signature
     enum AssetSignature {
         NoAssetSignature = 0,
@@ -23,7 +23,7 @@ namespace snowcrash {
         SchemaAssetSignature,       /// < Explicit Schema asset
         UndefinedAssetSignature = -1
     };
-    
+
     /** Body matching regex */
     const char* const BodyRegex = "^[[:blank:]]*[Bb]ody[[:blank:]]*$";
 
@@ -35,13 +35,13 @@ namespace snowcrash {
      */
     template<>
     struct SectionProcessor<Asset> : public SectionProcessorBase<Asset> {
-        
+
         static MarkdownNodeIterator processSignature(const MarkdownNodeIterator& node,
                                                      const MarkdownNodes& siblings,
                                                      SectionParserData& pd,
                                                      SectionLayout& layout,
-                                                     ParseResult<Asset>& out) {
-            
+                                                     const ParseResultRef<Asset>& out) {
+
             out.node = "";
             CodeBlockUtility::signatureContentAsCodeBlock(node, pd, out.report, out.node);
 
@@ -51,11 +51,11 @@ namespace snowcrash {
 
             return ++MarkdownNodeIterator(node);
         }
-        
+
         static MarkdownNodeIterator processDescription(const MarkdownNodeIterator& node,
                                                        const MarkdownNodes& siblings,
                                                        SectionParserData& pd,
-                                                       ParseResult<Asset>& out) {
+                                                       const ParseResultRef<Asset>& out) {
 
             return node;
         }
@@ -63,8 +63,8 @@ namespace snowcrash {
         static MarkdownNodeIterator processContent(const MarkdownNodeIterator& node,
                                                    const MarkdownNodes& siblings,
                                                    SectionParserData& pd,
-                                                   ParseResult<Asset>& out) {
-            
+                                                   const ParseResultRef<Asset>& out) {
+
             mdp::ByteBuffer content;
             CodeBlockUtility::contentAsCodeBlock(node, pd, out.report, content);
 
@@ -76,18 +76,18 @@ namespace snowcrash {
 
             return ++MarkdownNodeIterator(node);
         }
-        
+
         static bool isDescriptionNode(const MarkdownNodeIterator& node,
                                       SectionType sectionType) {
             return false;
         }
-        
+
         static bool isContentNode(const MarkdownNodeIterator& node,
                                   SectionType sectionType) {
 
             return (SectionKeywordSignature(node) == UndefinedSectionType);
         }
-        
+
         static SectionType sectionType(const MarkdownNodeIterator& node) {
             if (node->type == mdp::ListItemMarkdownNodeType
                 && !node->children().empty()) {
@@ -101,7 +101,7 @@ namespace snowcrash {
 
                     case SchemaAssetSignature:
                         return SchemaSectionType;
-                        
+
                     default:
                         return UndefinedSectionType;
                 }
@@ -109,24 +109,24 @@ namespace snowcrash {
 
             return UndefinedSectionType;
         }
-        
+
         /** Resolve asset signature */
         static AssetSignature assetSignature(const MarkdownNodeIterator& node) {
 
             mdp::ByteBuffer remaining, subject = node->children().front().text;
             subject = GetFirstLine(subject, remaining);
             TrimString(subject);
-            
+
             if (RegexMatch(subject, BodyRegex))
                 return BodyAssetSignature;
 
             if (RegexMatch(subject, SchemaRegex))
                 return SchemaAssetSignature;
-            
+
             return NoAssetSignature;
         }
     };
-    
+
     /** Asset Section Parser */
     typedef SectionParser<Asset, ListSectionAdapter> AssetParser;
 }

data/ext/snowcrash/src/Blueprint.h

@@ -13,6 +13,7 @@
 #include <string>
 #include <utility>
 #include "Platform.h"
+#include "MarkdownNode.h"
 
 /**
  *  API Blueprint Abstract Syntax Tree
@@ -22,36 +23,36 @@
  */
 
 namespace snowcrash {
-    
+
     /** Name of a an API Blueprint entity. */
     typedef std::string Name;
 
-    /** 
+    /**
      *  \brief An API Blueprint entity Description.
      *
-     *  Depending on parser setting the description might be 
+     *  Depending on parser setting the description might be
      *  rendered HTML from Markdown or raw Markdown.
      */
     typedef std::string Description;
-    
+
     /** URI */
     typedef std::string URI;
-    
+
     /** URI template */
     typedef std::string URITemplate;
-    
+
     /** HTTP Method */
     typedef std::string HTTPMethod;
 
     /** Parameter Type */
     typedef std::string Type;
-    
+
     /** Parameter Value */
     typedef std::string Value;
 
     /** A generic key - value pair */
     typedef std::pair<std::string, std::string> KeyValuePair;
-    
+
     /**
      * Default Container for collections.
      *
@@ -63,18 +64,18 @@ namespace snowcrash {
         typedef typename std::vector<T>::iterator iterator;
         typedef typename std::vector<T>::const_iterator const_iterator;
     };
-    
+
     /** An asset data */
     typedef std::string Asset;
 
-    /** 
+    /**
      *  \brief Metadata key-value pair,
      *
      *  E.g. "HOST: http://acme.com"
      */
     typedef KeyValuePair Metadata;
 
-    /** 
+    /**
      *  \brief  Header key-value pair.
      *
      *  E.g. "Content-Type: application/json"
@@ -86,7 +87,7 @@ namespace snowcrash {
 
     /** Headers */
     typedef Collection<Header>::type Headers;
-    
+
     /** Collection of Parameter Values */
     typedef Collection<Value>::type Values;
 
@@ -96,28 +97,28 @@ namespace snowcrash {
         OptionalParameterUse,
         RequiredParameterUse
     };
-    
+
     /** Parameter */
     struct Parameter {
-        
+
         /** Parameter Name */
         Name name;
-        
+
         /** Parameter Description */
         Description description;
-        
+
         /** Type */
         Type type;
-        
+
         /** Required flag */
         ParameterUse use;
-        
+
         /** Default Value, applicable only when `required == false` */
         Value defaultValue;
-        
+
         /** Example Value */
         Value exampleValue;
-        
+
         /** Enumeration of possible values */
         Values values;
     };
@@ -125,50 +126,84 @@ namespace snowcrash {
     /** Source Map of Collection of Parameters */
     typedef Collection<Parameter>::type Parameters;
 
-    /** Name of a symbol */
-    typedef std::string SymbolName;
+    /** Identifier(name) of Reference */
+    typedef std::string Identifier;
+
+    /** Reference */
+    struct Reference {
+
+        /** Reference Resolution State */
+        enum State {
+            StateUnresolved,    // Reference unresolved (undefined)
+            StatePending,       // Reference resolution pending
+            StateResolved       // Reference resolved successfully
+        };
+
+        /** Reference Type */
+        enum ReferenceType {
+            SymbolReference     // Reference as symbol
+        };
+
+        /** Identifier */
+        Identifier id;
+
+        /** Type */
+        ReferenceType type;
+
+        struct ReferenceMetadata {
+
+            /** Markdown AST reference source node (for source map) */
+            mdp::MarkdownNodeIterator node;
+
+            /** Reference resolution state */
+            State state;
+        };
+
+        /** Metadata for the reference */
+        ReferenceMetadata meta;
+    };
     
     /**
      *  Payload
      */
     struct Payload {
-        
+
         /** A Payload Name */
         Name name;
-        
+
         /** Payload Description */
         Description description;
-        
+
         /** Payload-specific Parameters */
         Parameters parameters;
-        
+
         /** Payload-specific Headers */
         Headers headers;
-        
+
         /** Body */
         Asset body;
-        
+
         /** Schema */
         Asset schema;
 
-        /** Symbol */
-        SymbolName symbol;
+        /** Reference */
+        Reference reference;
     };
-    
+
     /** Resource Model */
     typedef Payload ResourceModel;
-    
+
     /** Request */
     typedef Payload Request;
-    
-    /** 
+
+    /**
      *  \brief Response
      *
      *  A payload returned in a response to an action.
      *  Payload's name represents the HTTP status code.
      */
     typedef Payload Response;
-    
+
     /** Collection of Requests */
     typedef Collection<Request>::type Requests;
 
@@ -179,20 +214,20 @@ namespace snowcrash {
      *  An HTTP transaction example.
      */
     struct TransactionExample {
-        
+
         /** An example name */
         Name name;
-        
+
         /** Description */
         Description description;
-        
+
         /** Requests */
         Requests requests;
-        
+
         /** Responses */
         Responses responses;
     };
-    
+
     /** Collection of Transaction examples */
     typedef Collection<TransactionExample>::type TransactionExamples;
 
@@ -200,37 +235,37 @@ namespace snowcrash {
      *  Action
      */
     struct Action {
-        
+
         /** HTTP method */
         HTTPMethod method;
-        
+
         /** An Action name */
         Name name;
-        
+
         /** Description */
         Description description;
-        
+
         /** Action-specific Parameters */
         Parameters parameters;
-        
-        /** 
+
+        /**
          *  \brief Action-specific HTTP headers
          *
          *  DEPRECATION WARNING:
          *  --------------------
          *
          *  This AST node is build for deprecated API Blueprint syntax
-         *  and as such it will be removed in a future version of 
-         *  Snow Crash. 
-         *  
+         *  and as such it will be removed in a future version of
+         *  Snow Crash.
+         *
          *  Use respective payload's header collection instead.
          */
         DEPRECATED Headers headers;
-        
+
         /** Transactions examples */
         TransactionExamples examples;
     };
-    
+
     /** Collection of Actions */
     typedef Collection<Action>::type Actions;
 
@@ -238,22 +273,22 @@ namespace snowcrash {
      *  API Resource
      */
     struct Resource {
-        
+
         /** URI template */
         URITemplate uriTemplate;
-        
+
         /** A Resource Name */
         Name name;
-        
+
         /** Description of the resource */
         Description description;
-        
+
         /** Model representing this Resource */
         ResourceModel model;
-        
+
         /** Parameters */
         Parameters parameters;
-        
+
         /**
          *  \brief Resource-specific HTTP Headers
          *
@@ -267,11 +302,11 @@ namespace snowcrash {
          *  Use respective payload's header collection instead.
          */
         DEPRECATED Headers headers;
-        
+
         /** A set of Actions specified for this Resource */
         Actions actions;
     };
-    
+
     /** Collection of Resources */
     typedef Collection<Resource>::type Resources;
 
@@ -279,13 +314,13 @@ namespace snowcrash {
      *  Group of API Resources
      */
     struct ResourceGroup {
-        
+
         /** A Group Name */
         Name name;
-        
+
         /** Group description */
         Description description;
-        
+
         /** Resources */
         Resources resources;
     };
@@ -293,23 +328,23 @@ namespace snowcrash {
     /** Collection of Resource groups */
     typedef Collection<ResourceGroup>::type ResourceGroups;
 
-    /** 
+    /**
      *  \brief API Blueprint AST
      *
      *  This is top-level (or root if you prefer) of API Blueprint abstract syntax tree.
      *  Start reading a parsed API here.
      */
     struct Blueprint {
-        
+
         /** Metadata */
         MetadataCollection metadata;
-        
+
         /** The API Name */
         Name name;
 
         /** An API Overview description */
         Description description;
-        
+
         /** The set of API Resource Groups */
         ResourceGroups resourceGroups;
     };