1
1
mirror of https://github.com/github/semantic.git synced 2024-12-24 15:35:14 +03:00
semantic/src/Category.hs

370 lines
9.9 KiB
Haskell
Raw Normal View History

2016-11-10 02:39:07 +03:00
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE DeriveAnyClass #-}
{-# OPTIONS_GHC -funbox-strict-fields #-}
module Category where
2015-11-18 22:23:35 +03:00
2017-07-28 21:37:02 +03:00
import Control.DeepSeq
import Data.Functor.Listable
2017-07-28 21:37:02 +03:00
import Data.Hashable
import Data.Text (Text)
2017-08-22 20:06:39 +03:00
import Data.Text.Prettyprint.Doc
2017-07-28 21:37:02 +03:00
import GHC.Generics
2015-11-18 22:23:35 +03:00
2016-02-05 00:35:42 +03:00
-- | A standardized category of AST node. Used to determine the semantics for
-- | semantic diffing and define comparability of nodes.
data Category
-- | The top-level branch node.
= Program
2016-06-04 01:37:40 +03:00
-- | A node indicating syntax errors.
2017-01-25 11:08:06 +03:00
| ParseError
2016-06-16 17:54:05 +03:00
-- | A boolean expression.
| Boolean
-- | A bitwise operator.
| BitwiseOperator
2016-09-17 01:20:36 +03:00
-- | A boolean operator (e.g. ||, &&).
| BooleanOperator
2016-02-05 00:35:42 +03:00
-- | A literal key-value data structure.
2016-02-06 00:59:38 +03:00
| DictionaryLiteral
2016-02-14 05:01:52 +03:00
-- | A pair, e.g. of a key & value
| Pair
2016-02-06 00:54:08 +03:00
-- | A call to a function.
| FunctionCall
2016-06-10 22:19:29 +03:00
-- | A function declaration.
2016-06-10 20:11:32 +03:00
| Function
2016-06-10 22:19:29 +03:00
-- | An identifier.
| Identifier
2016-06-12 21:29:48 +03:00
-- | A function's parameters.
| Params
2016-06-12 21:29:48 +03:00
-- | A function's expression statements.
| ExpressionStatements
-- | A method call on an object.
| MethodCall
2016-06-14 19:53:35 +03:00
-- | A method's arguments.
| Args
-- | A string literal.
| StringLiteral
2017-01-18 22:06:45 +03:00
-- | An integer literal.
| IntegerLiteral
-- | A regex literal.
| Regex
-- | A return statement.
| Return
-- | A symbol literal.
| SymbolLiteral
2016-06-15 18:38:16 +03:00
-- | A template string literal.
| TemplateString
2016-03-03 07:01:46 +03:00
-- | An array literal.
| ArrayLiteral
2016-06-14 01:31:45 +03:00
-- | An assignment expression.
2016-06-14 00:31:32 +03:00
| Assignment
-- | A math assignment expression.
| MathAssignment
2016-06-14 01:31:45 +03:00
-- | A member access expression.
| MemberAccess
2016-06-17 22:38:12 +03:00
-- | A subscript access expression.
| SubscriptAccess
-- | A variable assignment within a variable declaration.
| VarAssignment
-- | A variable declaration.
| VarDecl
2016-06-17 23:31:50 +03:00
-- | A switch expression.
2016-06-16 01:48:27 +03:00
| Switch
2016-08-12 00:39:44 +03:00
-- | A if/else expression.
| If
2016-07-28 20:48:44 +03:00
-- | A for expression.
| For
2016-07-28 21:00:28 +03:00
-- | A while expression.
| While
-- | A do/while expression.
| DoWhile
2016-06-17 23:31:40 +03:00
-- | A ternary expression.
| Ternary
2016-06-17 23:31:50 +03:00
-- | A case expression.
2016-06-16 01:48:27 +03:00
| Case
2016-06-18 01:02:54 +03:00
-- | An expression with an operator.
| Operator
2016-08-16 22:44:02 +03:00
-- | An comma operator expression
| CommaOperator
2016-06-24 00:39:27 +03:00
-- | An object/dictionary/hash literal.
| Object
2016-07-29 22:32:54 +03:00
-- | A throw statement.
| Throw
2016-07-30 21:25:52 +03:00
-- | A constructor statement, e.g. new Foo;
| Constructor
2016-07-29 22:58:49 +03:00
-- | A try statement.
| Try
-- | A catch statement.
| Catch
-- | A finally statement.
| Finally
2016-07-29 23:28:27 +03:00
-- | A class declaration.
| Class
2016-07-30 06:41:21 +03:00
-- | A class method declaration.
| Method
-- | A comment.
| Comment
2016-02-05 00:35:42 +03:00
-- | A non-standard category, which can be used for comparability.
| Other Text
-- | A relational operator (e.g. < or >=)
| RelationalOperator
2016-08-19 22:53:04 +03:00
-- | An empty statement. (e.g. ; in JavaScript)
| Empty
2016-09-13 07:06:53 +03:00
-- | A number literal.
| NumberLiteral
2016-09-17 01:20:55 +03:00
-- | A mathematical operator (e.g. +, -, *, /).
| MathOperator
2016-10-04 01:18:09 +03:00
-- | A module
| Module
2017-03-28 22:40:10 +03:00
-- | A namespace in TypeScript.
| Namespace
2017-03-28 22:54:31 +03:00
-- | An interface
| Interface
2016-10-06 23:18:09 +03:00
-- | An import
| Import
-- | An export
| Export
-- | An anonymous function.
2016-11-01 21:36:23 +03:00
| AnonymousFunction
2016-10-24 20:43:31 +03:00
-- | An interpolation (e.g. "#{bar}" in Ruby)
2016-10-21 23:55:00 +03:00
| Interpolation
2016-10-24 20:43:31 +03:00
-- | A subshell command (e.g. `ls -la` in Ruby)
| Subshell
2016-12-06 22:42:41 +03:00
-- | Operator assignment, e.g. a ||= b, a += 1 in Ruby.
| OperatorAssignment
2016-10-26 20:27:38 +03:00
-- | A yield statement.
| Yield
-- | An until expression.
| Until
-- | A unless/else expression.
| Unless
2016-11-02 20:52:40 +03:00
| Begin
2016-11-02 21:10:01 +03:00
| Else
2016-11-02 22:32:46 +03:00
| Elsif
| Ensure
2016-11-02 23:05:30 +03:00
| Rescue
2017-01-19 22:01:01 +03:00
-- | Formerly used for Rubys @x rescue y@ modifier syntax. Deprecated. Use @Modifier Rescue@ instead. Left in place to preserve hashing & RWS results.
| RescueModifier
2016-11-07 19:00:06 +03:00
| RescuedException
| RescueArgs
| When
2016-11-08 01:23:17 +03:00
| Negate
2016-11-15 01:47:04 +03:00
-- | A select expression in Go.
| Select
| Defer
| Go
| Slice
2016-11-21 23:27:06 +03:00
| TypeAssertion
2016-11-21 23:44:31 +03:00
| TypeConversion
-- | An argument pair, e.g. foo(run: true) or foo(:run => true) in Ruby.
| ArgumentPair
-- | A keyword parameter, e.g. def foo(name:) or def foo(name:false) in Ruby.
2016-11-10 23:55:06 +03:00
| KeywordParameter
-- | An optional/default parameter, e.g. def foo(name = nil) in Ruby.
| OptionalParameter
-- | A splat parameter, e.g. def foo(*array) in Ruby.
| SplatParameter
-- | A hash splat parameter, e.g. def foo(**option) in Ruby.
| HashSplatParameter
-- | A block parameter, e.g. def foo(&block) in Ruby.
| BlockParameter
-- | A float literal.
| FloatLiteral
2017-01-18 22:01:14 +03:00
-- | An array type declaration, e.g. [2]string in Go.
| ArrayTy
2017-01-18 22:01:14 +03:00
-- | A dictionary type declaration, e.g. map[string] in Go.
| DictionaryTy
2017-01-18 22:01:14 +03:00
-- | A Struct type declaration, struct Foo {..} in Go.
| StructTy
2017-01-18 22:01:14 +03:00
-- | A Struct constructor, e.g. foo = Foo {..} in Go.
| Struct
2016-12-01 00:30:11 +03:00
-- | A break statement, e.g. break; in JavaScript.
| Break
-- | A continue statement, e.g. continue; in JavaScript.
| Continue
-- | A binary statement, e.g. a | b in Ruby.
| Binary
-- | A unary statement, e.g. !a in Ruby.
| Unary
-- | A constant, e.g `Foo::Bar` in Ruby.
| Constant
-- | A superclass, e.g `< Foo` in Ruby.
| Superclass
2016-12-11 19:36:26 +03:00
-- | A singleton class declaration, e.g. `class << self;end` in Ruby
2016-12-10 03:12:07 +03:00
| SingletonClass
2016-12-11 19:36:26 +03:00
-- | A range expression, e.g. `1..10` in Ruby.
| RangeExpression
2016-12-12 19:30:43 +03:00
-- | A scope resolution operator, e.g. `Foo::bar` in Ruby.
| ScopeOperator
2016-12-13 00:41:55 +03:00
-- | A BEGIN {} block of statements.
| BeginBlock
-- | An END {} block of statements.
| EndBlock
2017-01-10 23:09:09 +03:00
| ParameterDecl
2017-01-11 00:05:55 +03:00
-- | A default case in a switch statement.
2017-01-18 22:06:45 +03:00
| DefaultCase
2017-01-11 02:04:34 +03:00
-- | A type declaration.
| TypeDecl
2017-01-12 01:45:31 +03:00
| PointerTy
2017-01-12 02:05:51 +03:00
-- | A field declaration.
| FieldDecl
2017-01-12 22:38:35 +03:00
-- | A slice type, e.g. []string{"hello"} in Go.
| SliceTy
2017-01-12 22:38:44 +03:00
-- | An element of a slice literal.
| Element
2017-01-12 22:59:38 +03:00
-- | A literal value.
| Literal
2017-01-13 02:33:13 +03:00
-- | A channel type in Go.
| ChannelTy
2017-01-13 02:39:09 +03:00
-- | A send statement in Go.
| Send
2017-01-13 02:50:19 +03:00
-- | An Index expression, e.g. x[1] in Go.
| IndexExpression
2017-01-13 02:52:11 +03:00
-- | A function type.
| FunctionTy
-- | An increment statement, e.g. i++ in Go.
| IncrementStatement
-- | A decrement statement, e.g. i-- in Go.
| DecrementStatement
2017-01-14 03:46:16 +03:00
-- | A qualified identifier, e.g. Module.function in Go.
2017-08-03 18:00:20 +03:00
| QualifiedType
2017-01-17 20:23:56 +03:00
| FieldDeclarations
2017-01-18 02:55:59 +03:00
-- | A Go rune literal.
| RuneLiteral
-- | A modifier version of another Category, e.g. Rubys trailing @if@, @while@, etc. terms, whose subterms are swapped relative to regular @if@, @while@, etc. terms.
| Modifier Category
-- | A singleton method declaration, e.g. `def self.foo;end` in Ruby
| SingletonMethod
-- | An arbitrary type annotation.
| Ty
2017-08-03 18:00:20 +03:00
| ParenthesizedExpression
| ParenthesizedType
deriving (Eq, Generic, Ord, Show, NFData)
2016-06-23 16:55:48 +03:00
2017-01-19 22:01:01 +03:00
{-# DEPRECATED RescueModifier "Deprecated; use Modifier Rescue instead." #-}
2016-06-23 23:25:49 +03:00
-- Instances
2016-06-23 16:55:48 +03:00
instance Hashable Category
instance Listable Category where
tiers = cons0 Program
\/ cons0 ParseError
\/ cons0 Boolean
\/ cons0 BooleanOperator
-- \/ cons0 MathOperator
-- \/ cons0 DictionaryLiteral
-- \/ cons0 Pair
\/ cons0 FunctionCall
\/ cons0 Function
\/ cons0 Identifier
-- \/ cons0 Params
-- \/ cons0 ExpressionStatements
\/ cons0 MethodCall
-- \/ cons0 Args
\/ cons0 StringLiteral
\/ cons0 IntegerLiteral
\/ cons0 NumberLiteral
-- \/ cons0 Regex
\/ cons0 Return
-- \/ cons0 SymbolLiteral
-- \/ cons0 TemplateString
-- \/ cons0 ArrayLiteral
-- \/ cons0 Assignment
-- \/ cons0 MathAssignment
-- \/ cons0 MemberAccess
-- \/ cons0 SubscriptAccess
-- \/ cons0 VarAssignment
-- \/ cons0 VarDecl
-- \/ cons0 For
-- \/ cons0 DoWhile
-- \/ cons0 While
-- \/ cons0 Switch
\/ cons0 If
-- \/ cons0 Ternary
-- \/ cons0 Case
-- \/ cons0 Operator
-- \/ cons0 CommaOperator
-- \/ cons0 Object
-- \/ cons0 Throw
-- \/ cons0 Constructor
-- \/ cons0 Try
-- \/ cons0 Catch
-- \/ cons0 Finally
\/ cons0 Class
\/ cons0 Method
-- \/ cons0 Comment
-- \/ cons0 RelationalOperator
-- \/ cons0 Empty
-- \/ cons0 Module
-- \/ cons0 Import
-- \/ cons0 Export
-- \/ cons0 AnonymousFunction
-- \/ cons0 Interpolation
-- \/ cons0 Subshell
-- \/ cons0 OperatorAssignment
-- \/ cons0 Yield
-- \/ cons0 Until
-- \/ cons0 Unless
-- \/ cons0 Begin
-- \/ cons0 Else
-- \/ cons0 Elsif
-- \/ cons0 Ensure
-- \/ cons0 Rescue
-- \/ cons0 RescueModifier
-- \/ cons0 RescuedException
-- \/ cons0 RescueArgs
-- \/ cons0 When
-- \/ cons0 Negate
-- \/ cons0 Select
-- \/ cons0 Defer
-- \/ cons0 Go
-- \/ cons0 Slice
-- \/ cons0 TypeAssertion
-- \/ cons0 TypeConversion
-- \/ cons0 ArgumentPair
-- \/ cons0 KeywordParameter
-- \/ cons0 OptionalParameter
-- \/ cons0 SplatParameter
-- \/ cons0 HashSplatParameter
-- \/ cons0 BlockParameter
-- \/ cons0 FloatLiteral
-- \/ cons0 ArrayTy
-- \/ cons0 DictionaryTy
-- \/ cons0 StructTy
-- \/ cons0 Struct
-- \/ cons0 Break
-- \/ cons0 Continue
\/ cons0 Binary
\/ cons0 Unary
-- \/ cons0 Constant
-- \/ cons0 Superclass
-- \/ cons0 SingletonClass
-- \/ cons0 RangeExpression
-- \/ cons0 ScopeOperator
-- \/ cons0 BeginBlock
-- \/ cons0 EndBlock
-- \/ cons0 ParameterDecl
-- \/ cons0 DefaultCase
-- \/ cons0 TypeDecl
-- \/ cons0 PointerTy
-- \/ cons0 FieldDecl
-- \/ cons0 SliceTy
-- \/ cons0 Element
-- \/ cons0 Literal
-- \/ cons0 ChannelTy
-- \/ cons0 Send
-- \/ cons0 IndexExpression
-- \/ cons0 FunctionTy
-- \/ cons0 IncrementStatement
-- \/ cons0 DecrementStatement
2017-08-03 18:00:20 +03:00
-- \/ cons0 QualifiedType
-- \/ cons0 FieldDeclarations
-- \/ cons0 RuneLiteral
-- \/ cons0 (Modifier If)
\/ cons0 SingletonMethod
-- \/ cons0 (Other "other")
2017-08-22 20:06:39 +03:00
instance Pretty Category where
pretty = pretty . show