activefacts 1.6.0 → 1.7.1

data/lib/activefacts/cql/FactTypes.treetop

@@ -1,358 +0,0 @@
-#
-#       ActiveFacts CQL Parser.
-#       Parse rules relating to FactType definitions.
-#
-# Copyright (c) 2009 Clifford Heath. Read the LICENSE file.
-#
-module ActiveFacts
-  module CQL
-    grammar FactTypes
-      rule query
-	s query_clauses r:returning_clause? '?'
-	{
-	  def ast
-	    Compiler::FactType.new nil, [], query_clauses.ast, (r.empty? ? nil : r)
-	  end
-	}
-      end
-
-      rule named_fact_type
-	s each?
-        s term_definition_name
-        mapping_pragmas is_where
-        anonymous_fact_type
-        {
-	  def ast
-	    ft = anonymous_fact_type.ast
-	    ft.name = term_definition_name.value
-	    pragmas = mapping_pragmas.value
-	    pragmas << 'independent' if is_where.independent
-	    ft.pragmas = pragmas
-	    ft
-	  end
-        }
-      end
-
-      rule anonymous_fact_type
-        query_clauses
-          ctail:( (':' / where) s a:query_clauses s)?
-          returning_clause?
-        s ';'
-        {
-	  def ast
-            clauses_ast = query_clauses.ast
-            conditions = !ctail.empty? ? ctail.a.ast : []
-	    returning = respond_to?(:returning_clause) ? returning_clause.ast : nil
-	    value_derivation = clauses_ast.detect{|r| r.is_equality_comparison}
-	    if !value_derivation and
-		conditions.empty? and
-		clauses_ast.detect{|r| r.includes_literals}
-	      raise "Fact instances may not contain conditions" unless conditions.empty? && !returning
-	      Compiler::Fact.new clauses_ast
-	    elsif (clauses_ast.size == 1 &&
-	      clauses_ast[0].phrases.size == 1 &&
-	      (popname = clauses_ast[0].phrases[0]) &&
-	      !popname.is_a?(Compiler::Reference) &&
-	      conditions.detect{|r| r.includes_literals}
-	    )
-	      Compiler::Fact.new conditions, popname
-	    else
-	      Compiler::FactType.new nil, clauses_ast, conditions, returning
-	    end
-	  end
-        }
-      end
-
-      rule query_clauses
-        qualified_clauses
-	  # REVISIT: This creates no precedence between and/or, which could cause confusion.
-	  # Should disallow mixed conjuntions - using a sempred?
-          ftail:( conjunction:(',' / and / or ) s qualified_clauses s )*
-	{
-	  def ast
-            clauses_ast = qualified_clauses.ast
-            ftail.elements.each{|e|
-	      conjunction = e.conjunction.text_value
-	      # conjunction = 'and' if conjunction == ','   # ',' means AND, but disallows left-contractions
-	      clauses_ast += e.qualified_clauses.ast(conjunction)
-	    }
-	    clauses_ast
-	  end
-	}
-      end
-
-      rule returning_clause
-        returning s return (s ',' s return)*
-      end
-
-      rule return
-	ordering_prefix? phrase+
-      end
-
-      rule qualified_clauses
-        s certainty s contracted_clauses s p:post_qualifiers? s c:context_note?
-        {
-	  def ast(conjunction = nil)
-	    r = contracted_clauses.ast	# An array of clause asts
-	    r[0].conjunction = conjunction
-	    # pre-qualifiers apply to the first clause, post_qualifiers and context_note to the last
-	    # REVISIT: This may be incorrect where the last is a nested clause
-	    r[0].certainty = certainty.value
-	    r[-1].qualifiers += p.list unless p.empty?
-	    r[-1].context_note = c.ast unless c.empty?
-	    r
-	  end
-        }
-      end
-
-      rule certainty
-	negative_prefix { def value; false; end }
-	/
-        maybe { def value; nil; end }
-	/
-	definitely { def value; true; end }
-	/
-	'' { def value; true; end }
-      end
-
-      rule post_qualifiers
-        '[' s q0:post_qualifier tail:( s ',' s q1:post_qualifier )* s ']' s
-        {
-          def list
-            [q0.text_value, *tail.elements.map{|e| e.q1.text_value}]
-          end
-        }
-      end
-
-      rule post_qualifier
-        static / transient /
-	intransitive / stronglyintransitive / transitive / acyclic / symmetric / asymmetric / antisymmetric / reflexive / irreflexive
-      end
-
-      rule clauses_list
-        clauses tail:( ',' s clauses )*
-        {
-	  def ast
-	    [clauses.ast, *tail.elements.map{|e| e.clauses.ast }]
-	  end
-	}
-      end
-
-      rule clauses
-        contracted_clauses s tail:( and s contracted_clauses s )*
-        {
-	  def ast
-	    clauses = contracted_clauses.ast
-	    tail.elements.map{|e| clauses += e.contracted_clauses.ast }
-	    clauses
-	  end
-	}
-      end
-
-      rule contracted_clauses
-	comparison
-	/
-        (
-	  contraction	  # A contraction will terminate this repetition by eating to the end
-	  /
-	  phrase
-	)+
-        {
-	  def ast
-	    asts = elements.map{ |r| r.ast }
-	    contracted_clauses = []
-	    qualifiers = []
-	    if asts[-1].is_a?(Array)	    # A contraction (Array of [role, qualifiers, *clauses])
-	      contracted_clauses = asts.pop	    # Pull off the contracted_clauses
-	      contracted_role = contracted_clauses.shift
-	      qualifiers = contracted_clauses.shift
-	      asts.push(contracted_role)  # And replace it by the role removed from the contracted_clauses
-	    end
-	    clause_ast = Compiler::Clause.new(asts, qualifiers)
-	    [clause_ast] + contracted_clauses
-	  end
-        }
-      end
-
-      rule contraction
-	reading_contraction /
-	condition_contraction
-      end
-
-      rule reading_contraction
-	role p:post_qualifiers? conjunction:(that/who) s certainty s contracted_clauses s
-	{
-	  def ast
-	    # contracted_clauses.ast will return an array of Clauses, but the first clause is special. We must:
-	    # * prepend a new role (we get the Role to build *two* ast nodes)
-	    # * attach the qualifiers
-	    clauses_ast = contracted_clauses.ast
-	    clauses_ast[0].conjunction = conjunction.text_value
-	    clauses_ast[0].phrases.unshift(role.ast)
-	    clauses_ast[0].certainty = certainty.value
-
-	    # A contraction returns an array containing:
-	    # * a role AST
-	    # * a qualifiers array
-	    # * an array of Clauses
-	    [role.ast, p.empty? ? [] : p.list] + clauses_ast
-	  end
-	}
-      end
-
-      rule condition_contraction
-	role pq:post_qualifiers? certainty s comparator s e2:expression
-	  !phrase	  # The contracted_clauses must not continue here!
-	{
-	  def ast
-	    c = Compiler::Comparison.new(comparator.text_value, role.ast, e2.ast, certainty.value)
-	    c.conjunction = comparator.text_value
-	    [ role.ast, pq.empty? ? [] : pq.list, c ]
-	  end
-	}
-      end
-
-      rule comparison
-	e1:expression s certainty s comparator s contraction p:post_qualifiers?
-	{
-	  def ast
-	    role, qualifiers, *clauses_ast = *contraction.ast
-	    clauses_ast[0].qualifiers += p.list unless p.empty?	# apply post_qualifiers to the contracted clause
-	    # clauses_ast[0].conjunction = 'and' # AND is implicit for a contraction
-	    c = Compiler::Comparison.new(comparator.text_value, e1.ast, role, certainty.value)
-	    [c] + clauses_ast
-	  end
-	}
-        /
-	certainty e1:expression s comparator s e2:expression # comparisons have no post-qualifiers: p:post_qualifiers?
-        {
-	  def ast
-	    c = Compiler::Comparison.new(comparator.text_value, e1.ast, e2.ast, certainty.value)
-	    [c]
-	  end
-        }
-      end
-
-      rule comparator
-        '<=' / '<>' / '<' / '=' / '>=' / '>' / '!='
-      end
-
-      rule phrase
-	role    # A role reference containing a term, perhaps with attached paraphernalia
-	/       # A hyphenated non-term. Important: no embedded spaces
-	id tail:('-' !term id)+ s
-	  {
-	    def ast
-	      [id.value, *tail.elements.map{|e| e.id.value}]*"-"
-	    end
-	    def node_type; :linking; end
-	  }
-	/       # A normal non-term
-	!non_phrase id s
-	  {
-	    def ast
-	      id.value
-	    end
-	    def node_type; :linking; end
-	  }
-      end
-
-      rule role
-	aggregate
-	/
-	simple_role
-      end
-
-      rule aggregate
-	aggregate:id s
-	agg_of s term_or_unary s agg_in s    # REVISIT: this term may need to pre-scanned in the qualified_clauses
-	'(' qualified_clauses s ')' # REVISIT: Need to test to verify this is the right level (not query_clauses, etc)
-	{
-	  def ast
-	    raise "Not implemented: AST for '#{aggregate.text_value} of #{term_or_unary.text_value}'"
-	    # This returns just the role with the nested clauses, which doesn't even work:
-	    term.ast(
-	      nil,	# No quantifier
-	      nil,	# No function call
-	      nil,	# No role_name
-	      nil,	# No value_constraint
-	      nil,	# No literal
-	      qualified_clauses.ast
-	    )
-	  end
-	}
-      end
-
-      rule role_quantifier
-	quantifier mapping_pragmas enforcement cn:context_note?
-	{
-	  def ast
-	    Compiler::Quantifier.new(
-	      quantifier.value[0],
-	      quantifier.value[1],
-	      enforcement.ast,
-	      cn.empty? ? nil : cn.ast,
-	      mapping_pragmas.value
-	    )
-	  end
-	}
-      end
-
-      # This is the rule that causes most back-tracking. I think you can see why.
-      rule simple_role
-	q:role_quantifier?
-        player:derived_variable
-        lr:(
-	  literal u:unit?
-	  /
-	  value_constraint enforcement
-	)?
-	oj:objectification_step?
-        {
-	  def ast
-	    if !q.empty? && q.quantifier.value
-	      quantifier = q.ast
-	    end
-	    if !lr.empty?
-	      if lr.respond_to?(:literal)
-		literal = Compiler::Literal.new(lr.literal.value, lr.u.empty? ? nil : lr.u.text_value)
-	      end
-	      value_constraint = Compiler::ValueConstraint.new(lr.value_constraint.ast, lr.enforcement.ast) if lr.respond_to?(:value_constraint)
-	      raise "It is not permitted to provide both a literal value and a value constraint" if value_constraint and literal
-	    end
-
-	    nested_clauses =
-	      if oj.empty?
-		nil
-	      else
-		ast = oj.ast
-		ast[0].conjunction = 'where'
-		ast
-	      end
-	    player.ast(quantifier, value_constraint, literal, nested_clauses)
-	  end
-        }
-      end
-
-      rule objectification_step
-        '(' s in_which s facts:query_clauses s ')' s
-	{
-	  def ast
-	    facts.ast
-	  end
-	}
-      end
-
-      rule role_name
-        '(' s as S r:term s ')' s
-        { def value; r.value; end }
-      end
-
-      rule subscript
-        '(' s i:([1-9] [0-9]*) s ')' s 
-        { def value; i.text_value.to_i; end }
-      end
-
-    end
-  end
-end

data/lib/activefacts/cql/Language/English.treetop

@@ -1,315 +0,0 @@
-#
-#       ActiveFacts CQL Parser.
-#       Parse rules the English syntax of CQL.
-#
-# Copyright (c) 2009 Clifford Heath. Read the LICENSE file.
-#
-module ActiveFacts
-  module CQL
-    grammar English
-
-      # >>>>>>>>>>>>>>>>>>>> Object Types <<<<<<<<<<<<<<<<<<<<
-      # The pattern to introduce a Value Type
-      rule written_as
-        s 'is' s 'written' S as s
-      end
-
-      rule auto_assignment
-	'auto-assigned' S at s time:('assert' / 'commit') !alphanumeric s
-	{
-	  def auto_assigned_at
-	    time.text_value
-	  end
-	}
-      end
-
-      # The pattern to introduce an Entity Type
-      rule identified_by
-        identified s by s
-      end
-
-      rule basetype_expression
-        is s i:( independent s )? identification
-      end
-
-      # The pattern to introduce an Entity Subtype
-      rule subtype_prefix
-        'is' s 'a' s ('kind'/'subtype') s 'of' S
-      end
-
-      rule subtype_expression
-        subtype_prefix i:( independent s )? supertype_list ident:identification?
-      end
-
-      # The pattern to introduce an objectified fact type with implicit identification
-      rule is_where
-	is s i:(independent s)? where
-	{ def independent; !i.empty?; end }
-      end
-
-      rule in_which	# Introduce an objectification step
-	where /	    # Old syntax
-	in s which  # preferred syntax
-      end
-
-      # Units conversion keyword
-      rule conversion
-	converts s a:(approximately s)? to s
-	{
-	  def approximate?
-	    !a.empty?
-	  end
-	}
-      end
-
-      # >>>>>>>>>>>>>>>>>>>> Constraints <<<<<<<<<<<<<<<<<<<<
-      # External presence constraint syntax:
-      rule each_occurs_in_clauses
-        s 'each' s ('combination' S)? role_list s occurs s quantifier s 'time' 's'? s enforcement 'in' s
-	  clauses_list s c:context_note? ';'
-	{
-	  def role_list_ast
-	    role_list.ast
-	  end
-	  def quantifier_ast
-	    quantifier.ast
-	  end
-	  def clauses_ast
-	    clauses_list.ast
-	  end
-	}
-      end
-
-      # Alternate external presence constraint syntax:
-      rule either_or
-      s either? s r1:clauses s or s r2:clauses c:context_note? enforcement ';'
-      {
-	  def role_list_ast
-	    nil
-	  end
-	  def quantifier_ast
-	    Compiler::Quantifier.new(1, nil)
-	  end
-	  def clauses_ast
-	    [r1.ast, r2.ast]
-	  end
-	}
-      end
-
-      # Exclusion (at most one) and mandatory exclusion (exactly one) constraint syntax:
-      rule for_each_how_many
-        s 'for' s 'each' s role_list s quantifier s 'of' s 'these' s 'holds' s enforcement ':' s
-	  clauses_list s c:context_note? ';'
-	{
-	  def role_list_ast
-	    role_list.ast
-	  end
-	  def quantifier_ast
-	    quantifier.ast
-	  end
-	  def clauses_ast
-	    clauses_list.ast
-	  end
-	}
-      end
-
-      # Alternate mandatory exclusion constraint syntax:
-      rule either_or_not_both
-        s either? s r1:clauses s or s r2:clauses but s not s both s c:context_note? enforcement ';'
-	{
-	  def role_list_ast
-	    nil
-	  end
-	  def quantifier_ast
-	    Compiler::Quantifier.new(1, 1)
-	  end
-	  def clauses_ast
-	    [r1.ast, r2.ast]
-	  end
-	}
-      end
-
-      # Subset constraint using "A only if B" syntax
-      rule a_only_if_b
-	s clauses:query_clauses s only s if s r2:query_clauses s c:context_note? enforcement ';'
-      end
-
-      rule only_if
-	only s if s
-      end
-
-      # Subset constraint using "if A then B" syntax
-      rule if_b_then_a
-	s if s clauses s then s r2:clauses s c:context_note? enforcement ';'
-      end
-
-      # Equality constraint syntax:
-      rule if_and_only_if
-        s clauses s tail:( if s and s only s if s clauses s)+
-	  c:context_note? enforcement ';'
-      end
-
-      # During the prescan we need to know where terms in a role list finish.
-      # This rule matches any non-term expressions that may follow a role list.
-      rule role_list_constraint_followers
-	occurs s quantifier s 'time'
-      end
-
-      # >>>>>>>>>>>>>>>>>>>> Quantifiers <<<<<<<<<<<<<<<<<<<<
-      rule quantifier
-	(
-	  each s                    { def value; [1, nil]; end }
-	  / some s                  { def value; nil; end }
-	    # REVISIT: "Some" means that any prior occurrence of this role player is to be ignored; this is a new occurrence
-	    # "that" on the other hand means that this role player was *previously* designated using "some".
-	    # These distinctions are lost here
-	  / that s                  { def value; nil; end }
-	  / which s                 { def value; nil; end }
-	  / one s                   { def value; [1, 1]; end }
-	  / no s                    { def value; [0, 0]; end }
-	  / exactly s quantity      { def value; q = quantity.value; [q, q]; end }
-	  / at s least s quantity most:( and s at s most s q:quantity )?
-				    { def value;
-					[ quantity.value,
-					  most.empty? ? nil : most.q.value
-					]
-				      end
-				    }
-	  / at s most s quantity    { def value; [ nil, quantity.value ]; end }
-	  / from s numeric_range s  { def value; numeric_range.value; end }
-	# / either_all_or_none s    { def value; [ -1, 1 ]; end }
-	)
-	{
-	  def ast
-	    v = value
-	    Compiler::Quantifier.new(v[0], v[1])
-	  end
-	}
-      end
-
-      # rule either_all_or_none either s all s or s ( none / no ) end
-
-      rule quantity
-        one s                     { def value; 1; end }
-        / number s                { def value; number.value; end }
-      end
-
-      # >>>>>>>>>>>>>>>>>>>> Context Notes <<<<<<<<<<<<<<<<<<<<
-      rule as_agreed_by
-        s as s 'agreed' s d:('on' S date)? by s agents
-        { def value; [ d.empty? ? nil : d.date.value, agents.value ]; end }
-      end
-
-      rule date
-        s d:(!(by/')') .)+
-        { def value; d.text_value.strip; end }
-      end
-
-      rule agents
-        s h:agent s t:(',' s !context_type agent s)*
-        {
-	  def value; [h.text_value] + t.elements.map{|e| e.agent.text_value }; end
-	  def node_type; :linking; end
-	}
-      end
-
-      rule agent
-        id (s id)*
-      end
-
-      rule negative_prefix
-	s it s is s not s the s case s that s
-      end
-
-      rule agg_of of end 
-      rule agg_in in end 
-      rule restricted_to 'restricted' s 'to' s !alphanumeric end
-      # any is optionally used in an identifying role_list
-      rule any one / a end
-
-      # >>>>>>>>>>>>>>>>>>>> Internal vocabulary <<<<<<<<<<<<<<<<<<<<
-      rule a ('a' !alphanumeric /'an' !alphanumeric) end
-      rule all 'all' !alphanumeric end
-      rule ascending 'ascending' !alphanumeric end
-      rule at 'at' !alphanumeric end
-      rule both 'both' !alphanumeric end 
-      rule converts 'converts' !alphanumeric end 
-      rule descending 'descending' !alphanumeric end
-      rule each 'each' !alphanumeric end 
-      rule either 'either' !alphanumeric end 
-      rule entity 'entity' !alphanumeric end 
-      rule exactly 'exactly' !alphanumeric end
-      rule from  'from' !alphanumeric end
-      rule includes 'includes' !alphanumeric end
-      rule least 'least' !alphanumeric end
-      rule matches 'matches' !alphanumeric end
-      rule most 'most' !alphanumeric end
-      rule no 'no' !alphanumeric end
-      rule none 'none' !alphanumeric end
-      rule not 'not' !alphanumeric end
-      rule occurs 'occurs' !alphanumeric end
-      rule one 'one' !alphanumeric end
-      rule some 'some' !alphanumeric end
-
-      # >>>>>>>>>>>>>>>>>>>> External vocabulary <<<<<<<<<<<<<<<<<<<<
-      rule according_to 'according' S to end
-      rule acyclic 'acyclic' !alphanumeric end
-      rule alias 'alias' !alphanumeric end 
-      rule and 'and' !alphanumeric end
-      rule antisymmetric 'antisymmetric' !alphanumeric end
-      rule approximately 'approximately' !alphanumeric end
-      rule as 'as' !alphanumeric end
-      rule as_opposed_to as s 'opposed' S to end 
-      rule asymmetric 'asymmetric' !alphanumeric end
-      rule because 'because' !alphanumeric end
-      rule but 'but' !alphanumeric end 
-      rule by 'by' !alphanumeric end			      # fix? Used in 'returning' for ordering
-      rule case 'case' !alphanumeric end 
-      rule definitely 'definitely' !alphanumeric end
-      rule ephemera 'ephemera' !alphanumeric end 
-      rule false 'false' !alphanumeric end 
-      rule feminine 'feminine' !alphanumeric end 
-      rule identified ('known'/'identified') !alphanumeric end 
-      rule if 'if' !alphanumeric end
-      rule in 'in' !alphanumeric end
-      rule import 'import' !alphanumeric end
-      rule independent 'independent' !alphanumeric end 
-      rule stronglyintransitive 'strongly' s 'intransitive' !alphanumeric end
-      rule intransitive 'intransitive' !alphanumeric end
-      rule irreflexive 'irreflexive' !alphanumeric end
-      rule is 'is' !alphanumeric end 
-      rule it 'it' !alphanumeric end
-      rule its 'its' !alphanumeric end
-      rule masculine 'masculine' !alphanumeric end 
-      rule maybe 'maybe' !alphanumeric end
-      rule only 'only' !alphanumeric end
-      rule or 'or' !alphanumeric end 
-      rule of 'of' !alphanumeric end 
-      rule ordering_prefix by s (ascending/descending)? s end
-      rule otherwise 'otherwise' !alphanumeric end 
-      rule partitioned 'partitioned' !alphanumeric end 
-      rule personal 'personal' !alphanumeric end 
-      rule radix_point '.' end
-      rule reflexive 'reflexive' !alphanumeric end
-      rule returning 'returning' !alphanumeric end
-      rule separate 'separate' !alphanumeric end 
-      rule so_that 'so' S that end
-      rule static 'static' !alphanumeric end
-      rule symmetric 'symmetric' !alphanumeric end
-      rule that 'that' !alphanumeric end
-      rule the 'the' !alphanumeric end 
-      rule then 'then' !alphanumeric end
-      rule to 'to' !alphanumeric end
-      rule to_avoid to s 'avoid' !alphanumeric end
-      rule transient 'transient' !alphanumeric end
-      rule transitive 'transitive' !alphanumeric end
-      rule true 'true' !alphanumeric end 
-      rule vocabulary 'vocabulary' !alphanumeric end 
-      rule where 'where' !alphanumeric end 
-      rule which 'which' !alphanumeric end 
-      rule was 'was' !alphanumeric end 
-      rule who 'who' !alphanumeric end 
-
-    end
-  end
-end