update docs

Language/SQL/SimpleSQL/Parser.lhs

@@ -962,7 +962,7 @@ allows offset and fetch in either order
 
 > fetch :: Parser ValueExpr
 > fetch = choice [ansiFetch, limit]
->   where --todo: better left factoring
+>   where
 >     fs = makeKeywordTree ["fetch first", "fetch next"]
 >     ro = makeKeywordTree ["rows only", "row only"]
 >     ansiFetch = fs *> valueExpr <* ro
@@ -1208,7 +1208,7 @@ todo: work out the symbol parsing better
 >          optionSuffix moreString (s0 ++ "'" ++ s)
 >         ,-- handle string in separate parts
 >          -- e.g. 'part 1' 'part 2'
->          do
+>          do --can this whitespace be factored out?
 >          try (whitespace <* nlquote)
 >          s <- manyTill anyChar nlquote
 >          optionSuffix moreString (s0 ++ s)

TODO

@@ -1,38 +1,26 @@
 continue 2003 review and tests
-docs: how to run the tests
+
 touch up the expr hack as best as can
-left factor as much as possible (see below on notes)
+
-table expression in syntax:
-  QueryExpr = Select SelectList (Maybe TableExpr)
-  and the TableExpr contains all the other bits?
-finish off ansi 2003 support or specific subset
-start looking at error messages
-change the booleans in the ast to better types for less ambiguity
-represent missing optional bits in the ast as nothing instead of the
-   default
-look at fixing the expression parsing completely
 represent natural and using/on in the syntax more close to the
    concrete syntax - don't combine in the ast
-review haddock in the syntax and update
+
-review syntax names and representation
 careful review of token parses wrt trailing delimiters/junk
 
-decide how to handle character set literals and identifiers: don't
+undo mess in the code created by adding lots of new support:
-   have any intention of actually supporting switching character sets
+much more documentation
-   in the middle of parsing so maybe this would be better disabled?
+refactor crufty bits
+reorder the code
+reconsider the names and structure of the constructors in the syntax
+refactor the typename parser - it's a real mess
 
-review places in the parse which should allow only a fixed set of
+add documentation in Parser.lhs on the left factoring/error handling
-   identifiers (e.g. in interval literals)
+   approach
 
-decide whether to represent numeric literals better, instead of a
+create error message demonstration page for the website
-   single string - break up into parts, or parse to a Decimal or
-   something
 
-refactor the typename parsing
+remove the IsString for Name and [Name], create some helper functions
-
+   if needed. These are only used in the tests
-reorder the parser and syntax (and the pretty)
-
-remove the IsString for Name and [Name]
 
 fixes:
 
@@ -44,25 +32,51 @@ keyword tree support prefix mode so can start from already parsed
 do the final big left factor: typenames, interval lits, iden +
    suffixes
 
+left factor/try removal summary (needs updating):
+
+identifier starts:
+  interval literal
+  character set literal
+  typed literals, multikeywords
+  identifier
+  app, agg, window
+  keyword function
+issues in the special op internals
+not between + other ops: needs new expression parsing
+  not in also
+  in suffix also
+  lots of overlap with binary and postfix multi keyword operators
+  quantified comparison also
+issues in the typename parsing
+dot in identifiers and as operator
+issues in the symbol parser
+  hardcode all the symbols in the symbol parser/split?
+conflict with in suffix and in in position
+
+rules for changing the multi keyword parsing:
+  if a keyword must be followed by another
+    e.g. left join, want to refactor to produce 'expected "left join"'
+  if the keyword is optionally followed by another, e.g. with
+   recursive, then don't do this.
+
+
 rough SQL 2003 todo, including tests to write:
 
-idens: "", unicode
+now:
-date and time literals
+implement the reservation of all keywords
-multisets
+go through all? the functions
-review window functions, window clause
+go through almost all the predicates
-review cases
+window functions missing bits, window clauses
-search/cycle, exclusions
+from: more tests, review missing
-special operators
+  tablesample, unnest, etc.
-from clause review
+aggregates: where, filter + review
-table sample
-unnest
-filter in aggs
-within group in aggs
 rows review
-matching simple partial full
+match missing bit
+between symmetric
+case review
 
-
+detail list from the grammar, LNR = maybe leave until after next
-LNR: maybe leave until after next release
+   release, otherwise planned for next release
 
 LNR support needed MODULE syntax in identifiers - already covered?
 LNR decide how to represent special identifiers including the session
@@ -83,8 +97,6 @@ translate
 trim
 overlay
 LNR specifictype
-datetime value expressions
-intervals
 row value constructors, expressions review
 review table value constructor exactly what is allowed
 lots more tests for from clause variations
@@ -95,7 +107,7 @@ only spec
 join variations, including union join
 review group by
 window clauses
-all fields reference with alias 'select * as (a,b,c) ... '
+LNR all fields reference with alias 'select * as (a,b,c) ... '
 search or cycle clause
 between symmetric/asymmetric
 in predicate review
@@ -110,42 +122,49 @@ submultiset predicate
 set predicate
 LNR type predicate
 additional stuff review:
-interval stuff
+complete the list of keywords/reserved keywords and check everything
-aggregate functions: lots of missing bits
+   still works ok. The parser will reject all unquoted identifiers
-  especially: filter where, within group
+   which are the same as reserved or unreserved keywords.
-complete list of keywords/reserved keywords
 LNR select into
 LNR other language format identifiers for host params?
 
-----
+
-above not marked LNR are for next release
+
+---
+
+after next release
 
 review areas where this parser is too permissive, e.g. value
    expressions allowed where column reference names only should be
    allowed, such as group by, order by (perhaps there can be a flag or
    warnings or something), unqualified asterisk in select list
 
+fix the expression parser completely: the realistic way is to adjust
+   for precedence and associativity after parsing since the concrete
+   syntax is so messy. should also use this expression parser for
+   parsing joins and for set operations, maybe other areas.
 
-left factor/try removal:
+table expression in syntax:
+  QueryExpr = Select SelectList (Maybe TableExpr)
+  and the TableExpr contains all the other bits?
 
-character set literal: leading identifier
+change the booleans in the ast to better types for less ambiguity?
-typed literal: leading identifier
+
-special operators: needs some rewriting to remove try
+decide how to handle character set literals and identifiers: don't
-  + left factor with iden( patterns
+   have any intention of actually supporting switching character sets
-conflict with in suffix and in in position
+   in the middle of parsing so maybe this would be better disabled?
-conflict with not prefix op and not between??
+
-multi word type names: left factor
+review places in the parse which should allow only a fixed set of
-quantified comparison: left factor with normal comparison
+   identifiers (e.g. in interval literals), keep in mind other
-multi word operator names in expressions
+   dialects and extensibility
-hardcode all the symbols in the symbol parser/split?
+
-left factor the not in 'not in' and 'not between', maybe others
+decide whether to represent numeric literals better, instead of a
-rules for changing the multi keyword parsing:
+   single string - break up into parts, or parse to a Decimal or
-  if a keyword must be followed by another
+   something
-    e.g. left join, want to refactor to produce 'expected "left join"'
+
-  if the keyword is optionally followed by another, e.g. with
+
-   recursive, then don't do this.
+= future big feature summary
 
-future big feature summary:
 all ansi sql queries
 completely working expression tree parsing
 error messages, left factor
@@ -159,6 +178,8 @@ typesafe sql dbms wrapper support for haskell
 extensibility
 performance analysis
 
+try out uu-parsing or polyparse, especially wrt error message
+   improvements
 
 = stuff
 

changelog

@@ -1,7 +1,6 @@
-0.4.0-dev (updated to 37dca6596bee307749bd74d01303c12235342c65)
+0.4.0-dev (updated to 7a847045163feb2339ab40ebe93afe2f1c9ad813)
 	completely remove dependency on haskell-src-exts
-	remove lots of 'try' from the parser, and add some other code
+	improve the error messages a great deal
-	  which should start to improve the error messages
 	fix some trailing whitespace issues in the keyword style functions,
 	  e.g. extract(day from x), dealing with trailing whitespace on
 	  the parens was fixed
@@ -18,8 +17,8 @@
 	fix corresponding bug where 'distinct' was being pretty printed in
 	  this case and 'all' was not since the assumed default was the
 	  wrong way round
-	replace Int with Integer in the Syntax
+	replace Int with Integer in the syntax
-	derive Data and Typeable in all the Syntax types
+	derive Data and Typeable in all the syntax types
 	remove support for parsing clauses after the from clause if there
 	  is no from clause
 	fix some trailing junk lexing issues with symbols and number
@@ -38,6 +37,21 @@
 	  the new collate postfix operator, this also changes the collation
 	  name to be an identifier instead of a string
 	support escape for string literals as a postfix operator
+	represent missing setquantifier as a literal default instead of as
+	  the actual default value (all in select, distinct in set
+	  operators)
+	same for sort directions in order by
+	parse schema/whatever qualified ids in various places: identifiers
+	  (replaces equivalent functionality using '.' operator), function,
+	  aggregate, window function names, explicit tables and functions in
+	  from clauses, typenames
+	support what appears to be 100% of sql 2003 typename syntax (phew)
+	support most multiset operations (missing some predicates only,
+	  likely to be added before next release)
+	support two double quotes in a quoted identifier to represent a
+	  quote character in the identifier
+	implement complete interval literals (fixed the handling of the
+	  interval qualifier)
 0.3.1 (commit 5cba9a1cac19d66166aed2876d809aef892ff59f)
 	update to work with ghc 7.8.1
 0.3.0 (commit 9e75fa93650b4f1a08d94f4225a243bcc50445ae)