graphql-java · bbakerman · Jan 23, 2018 · Sep 11, 2017 · Sep 11, 2017 · Sep 11, 2017
diff --git a/src/main/antlr/Graphql.g4 b/src/main/antlr/Graphql.g4
@@ -62,27 +62,35 @@ typeCondition : 'on' typeName;
 name: NAME | FRAGMENT | QUERY | MUTATION | SUBSCRIPTION | SCHEMA | SCALAR | TYPE | INTERFACE | IMPLEMENTS | ENUM | UNION | INPUT | EXTEND | DIRECTIVE;
 
 value :
+stringValue |
 IntValue |
 FloatValue |
-StringValue |
 BooleanValue |
 NullValue |
 enumValue |
 arrayValue |
 objectValue;
 
+
 valueWithVariable :
 variable |
+stringValue |
 IntValue |
 FloatValue |
-StringValue |
 BooleanValue |
 NullValue |
 enumValue |
 arrayValueWithVariable |
 objectValueWithVariable;
 
 
+stringValue
+ : TripleQuotedStringValue
+ | StringValue
+ ;
+
+description : stringValue;
+
 enumValue : name ;
 
 // Array Value
@@ -115,16 +123,16 @@ nonNullType: typeName '!' | listType '!';
 
 
 // Type System
-typeSystemDefinition:
+typeSystemDefinition: description?
 schemaDefinition |
 typeDefinition |
 typeExtensionDefinition |
 directiveDefinition
 ;
 
-schemaDefinition : SCHEMA directives? '{' operationTypeDefinition+ '}';
+schemaDefinition : description? SCHEMA directives? '{' operationTypeDefinition+ '}';
 
-operationTypeDefinition : operationType ':' typeName;
+operationTypeDefinition : description? operationType ':' typeName;
 
 typeDefinition:
 scalarTypeDefinition |
@@ -135,36 +143,40 @@ enumTypeDefinition |
 inputObjectTypeDefinition
 ;
 
-scalarTypeDefinition : SCALAR name directives?;
+scalarTypeDefinition : description? SCALAR name directives?;
 
-objectTypeDefinition : TYPE name implementsInterfaces? directives? '{' fieldDefinition+ '}';
+objectTypeDefinition : description? TYPE name implementsInterfaces? directives? '{' fieldDefinition+ '}';
 
 implementsInterfaces : IMPLEMENTS typeName+;
 
-fieldDefinition : name argumentsDefinition? ':' type directives?;
+fieldDefinition : description? name argumentsDefinition? ':' type directives?;
 
 argumentsDefinition : '(' inputValueDefinition+ ')';
 
-inputValueDefinition : name ':' type defaultValue? directives?;
+inputValueDefinition : description? name ':' type defaultValue? directives?;
 
-interfaceTypeDefinition : INTERFACE name directives? '{' fieldDefinition+ '}';
+interfaceTypeDefinition : description? INTERFACE name directives? '{' fieldDefinition+ '}';
 
-unionTypeDefinition : UNION name directives? '=' unionMembers;
+unionTypeDefinition : description? UNION name directives? '=' unionMembers;
 
 unionMembers:
 typeName |
 unionMembers '|' typeName
 ;
 
-enumTypeDefinition : ENUM name directives? '{' enumValueDefinition+ '}';
+enumTypeDefinition : description? ENUM name directives? '{' enumValueDefinition+ '}';
 
-enumValueDefinition : enumValue directives?;
+enumValueDefinition : description? enumValue directives?;
 
-inputObjectTypeDefinition : INPUT name directives? '{' inputValueDefinition+ '}';
+inputObjectTypeDefinition : description? INPUT name directives? '{' inputValueDefinition+ '}';
 
+//
+// type extensions dont get "description" strings according to reference implementation
+// https://github.com/graphql/graphql-js/pull/927/files#diff-b9370666fe8cd9ff4dd53e89e60d26afR182
+//
 typeExtensionDefinition : EXTEND objectTypeDefinition;
 
-directiveDefinition : DIRECTIVE '@' name argumentsDefinition? 'on' directiveLocations;
+directiveDefinition : description? DIRECTIVE '@' name argumentsDefinition? 'on' directiveLocations;
 
 directiveLocation : name;
 
@@ -212,7 +224,19 @@ ExponentPart : ('e'|'E') Sign? Digit+;
 Digit : '0'..'9';
 
 
-StringValue: '"' (~(["\\\n\r\u2028\u2029])|EscapedChar)* '"';
+StringValue
+ : '"' ( ~["\\\n\r\u2028\u2029] | EscapedChar )* '"'
+ ;
+
+TripleQuotedStringValue
+ : '"""' TripleQuotedStringPart? '"""'
+ ;
+
+
+// Fragments never become a token of their own: they are only used inside other lexer rules
+fragment TripleQuotedStringPart : ( EscapedTripleQuote | SourceCharacter )+?;
+fragment EscapedTripleQuote : '\\"""';
+fragment SourceCharacter :[\u0009\u000A\u000D\u0020-\uFFFF];
 
 Comment: '#' ~[\n\r\u2028\u2029]* -> channel(2);
 

diff --git a/src/main/java/graphql/language/Description.java b/src/main/java/graphql/language/Description.java
@@ -0,0 +1,25 @@
+package graphql.language;
+
+public class Description {
+    public final String content;
+    public final SourceLocation sourceLocation;
+    public final boolean multiLine;
+
+    public Description(String content, SourceLocation sourceLocation, boolean multiLine) {
+        this.content = content;
+        this.sourceLocation = sourceLocation;
+        this.multiLine = multiLine;
+    }
+
+    public String getContent() {
+        return content;
+    }
+
+    public SourceLocation getSourceLocation() {
+        return sourceLocation;
+    }
+
+    public boolean isMultiLine() {
+        return multiLine;
+    }
+}
diff --git a/src/main/java/graphql/language/DirectiveDefinition.java b/src/main/java/graphql/language/DirectiveDefinition.java
@@ -6,6 +6,7 @@
 
 public class DirectiveDefinition extends AbstractNode<DirectiveDefinition> implements Definition<DirectiveDefinition> {
     private final String name;
+    private Description description;
     private final List<InputValueDefinition> inputValueDefinitions;
     private final List<DirectiveLocation> directiveLocations;
 
@@ -23,6 +24,14 @@ public String getName() {
         return name;
     }
 
+    public Description getDescription() {
+        return description;
+    }
+
+    public void setDescription(Description description) {
+        this.description = description;
+    }
+
     public List<InputValueDefinition> getInputValueDefinitions() {
         return inputValueDefinitions;
     }

diff --git a/src/main/java/graphql/language/EnumTypeDefinition.java b/src/main/java/graphql/language/EnumTypeDefinition.java
@@ -8,6 +8,7 @@
 
 public class EnumTypeDefinition extends AbstractNode<EnumTypeDefinition> implements TypeDefinition<EnumTypeDefinition> {
     private final String name;
+    private Description description;
     private final List<EnumValueDefinition> enumValueDefinitions;
     private final List<Directive> directives;
 
@@ -47,6 +48,14 @@ public String getName() {
         return name;
     }
 
+    public Description getDescription() {
+        return description;
+    }
+
+    public void setDescription(Description description) {
+        this.description = description;
+    }
+
     @Override
     public List<Node> getChildren() {
         List<Node> result = new ArrayList<>();

diff --git a/src/main/java/graphql/language/EnumValueDefinition.java b/src/main/java/graphql/language/EnumValueDefinition.java
@@ -7,6 +7,7 @@
 
 public class EnumValueDefinition extends AbstractNode<EnumValueDefinition> {
     private final String name;
+    private Description description;
     private final List<Directive> directives;
 
     public EnumValueDefinition(String name) {
@@ -22,6 +23,14 @@ public String getName() {
         return name;
     }
 
+    public Description getDescription() {
+        return description;
+    }
+
+    public void setDescription(Description description) {
+        this.description = description;
+    }
+
     public List<Directive> getDirectives() {
         return directives;
     }

diff --git a/src/main/java/graphql/language/FieldDefinition.java b/src/main/java/graphql/language/FieldDefinition.java
@@ -10,6 +10,7 @@
 public class FieldDefinition extends AbstractNode<FieldDefinition> {
     private final String name;
     private Type type;
+    private Description description;
     private final List<InputValueDefinition> inputValueDefinitions;
     private final List<Directive> directives;
 
@@ -40,6 +41,14 @@ public String getName() {
         return name;
     }
 
+    public Description getDescription() {
+        return description;
+    }
+
+    public void setDescription(Description description) {
+        this.description = description;
+    }
+
     public List<InputValueDefinition> getInputValueDefinitions() {
         return inputValueDefinitions;
     }
@@ -73,7 +82,7 @@ public boolean isEqualTo(Node o) {
 
         FieldDefinition that = (FieldDefinition) o;
 
-        return NodeUtil.isEqualTo(this.name, that.name);
+         return NodeUtil.isEqualTo(this.name,that.name) ;
     }
 
     @Override

diff --git a/src/main/java/graphql/language/InputObjectTypeDefinition.java b/src/main/java/graphql/language/InputObjectTypeDefinition.java
@@ -9,6 +9,7 @@
 
 public class InputObjectTypeDefinition extends AbstractNode<InputObjectTypeDefinition> implements TypeDefinition<InputObjectTypeDefinition> {
     private final String name;
+    private Description description;
     private final List<Directive> directives;
     private final List<InputValueDefinition> inputValueDefinitions;
 
@@ -43,6 +44,14 @@ public String getName() {
         return name;
     }
 
+    public Description getDescription() {
+        return description;
+    }
+
+    public void setDescription(Description description) {
+        this.description = description;
+    }
+
     @Override
     public List<Node> getChildren() {
         List<Node> result = new ArrayList<>();
@@ -58,8 +67,8 @@ public boolean isEqualTo(Node o) {
 
         InputObjectTypeDefinition that = (InputObjectTypeDefinition) o;
 
-        return NodeUtil.isEqualTo(this.name, that.name);
-    }
+         return NodeUtil.isEqualTo(this.name,that.name) ;
+            }
 
     @Override
     public InputObjectTypeDefinition deepCopy() {

diff --git a/src/main/java/graphql/language/InputValueDefinition.java b/src/main/java/graphql/language/InputValueDefinition.java
@@ -11,6 +11,7 @@ public class InputValueDefinition extends AbstractNode<InputValueDefinition> {
     private final String name;
     private Type type;
     private Value defaultValue;
+    private Description description;
     private final List<Directive> directives;
 
     public InputValueDefinition(String name) {
@@ -44,6 +45,14 @@ public String getName() {
         return name;
     }
 
+    public Description getDescription() {
+        return description;
+    }
+
+    public void setDescription(Description description) {
+        this.description = description;
+    }
+
     public Value getDefaultValue() {
         return defaultValue;
     }

diff --git a/src/main/java/graphql/language/InterfaceTypeDefinition.java b/src/main/java/graphql/language/InterfaceTypeDefinition.java
@@ -9,6 +9,7 @@
 
 public class InterfaceTypeDefinition extends AbstractNode<InterfaceTypeDefinition> implements TypeDefinition<InterfaceTypeDefinition> {
     private final String name;
+    private Description description;
     private final List<FieldDefinition> definitions;
     private final List<Directive> directives;
 
@@ -43,6 +44,14 @@ public String getName() {
         return name;
     }
 
+    public Description getDescription() {
+        return description;
+    }
+
+    public void setDescription(Description description) {
+        this.description = description;
+    }
+
     @Override
     public List<Node> getChildren() {
         List<Node> result = new ArrayList<>();
@@ -58,7 +67,7 @@ public boolean isEqualTo(Node o) {
 
         InterfaceTypeDefinition that = (InterfaceTypeDefinition) o;
 
-        return NodeUtil.isEqualTo(this.name, that.name);
+         return NodeUtil.isEqualTo(this.name,that.name) ;
     }
 
     @Override

diff --git a/src/main/java/graphql/language/ObjectTypeDefinition.java b/src/main/java/graphql/language/ObjectTypeDefinition.java
@@ -9,6 +9,7 @@
 
 public class ObjectTypeDefinition extends AbstractNode<ObjectTypeDefinition> implements TypeDefinition<ObjectTypeDefinition> {
     private String name;
+    private Description description;
     private final List<Type> implementz;
     private final List<Directive> directives;
     private final List<FieldDefinition> fieldDefinitions;
@@ -53,6 +54,14 @@ public void setName(String name) {
         this.name = name;
     }
 
+    public Description getDescription() {
+        return description;
+    }
+
+    public void setDescription(Description description) {
+        this.description = description;
+    }
+
     @Override
     public List<Node> getChildren() {
         List<Node> result = new ArrayList<>();

diff --git a/src/main/java/graphql/language/ScalarTypeDefinition.java b/src/main/java/graphql/language/ScalarTypeDefinition.java
@@ -9,6 +9,7 @@
 
 public class ScalarTypeDefinition extends AbstractNode<ScalarTypeDefinition> implements TypeDefinition<ScalarTypeDefinition> {
     private final String name;
+    private Description description;
     private final List<Directive> directives;
 
     public ScalarTypeDefinition(String name) {
@@ -37,6 +38,15 @@ public String getName() {
         return name;
     }
 
+
+    public Description getDescription() {
+        return description;
+    }
+
+    public void setDescription(Description description) {
+        this.description = description;
+    }
+
     @Override
     public List<Node> getChildren() {
         List<Node> result = new ArrayList<>();