Documentaion

Class: CodeDocument

(Namespace: IntoTheCode)

Inherits IntoTheCode.TextElement
Represents a code document.

Function: Load(IntoTheCode.Parser,System.String)

• Parameter parser:
• Parameter input:
• Returns:
  Parse code with a given parser.

Function: GetValue()

Function: ToMarkup(System.Boolean)

• Parameter xmlEncode: Encode the values to xml.
• Returns: A string of markup.
  Transform document to markup.

Class: CodeElement

(Namespace: IntoTheCode)

Inherits IntoTheCode.TextElement
The Elements that is read as part of a syntax.

Class: Parser

(Namespace: IntoTheCode)
Read text according to a grammar. The parser holds the parser elements to read a code. Parser = a program that reads code, acording to a grammar. ParserElement = an element of a program that reads code elements, acording to a syntax element.

Property: Name
Name of grammar; The name of the first rule.

Property: Rules
Property for parser elements.

Constructor(System.String)

• Parameter Grammar: Create parser for proces Grammar definition. If empty a meta Grammar is created.
  Create parser.

Function: GetGrammar()

• Returns: A grammar.
  Get formatted grammar for this parser.

Class: NotifyChanges

(Namespace: IntoTheCode.Basic.Layer)
Baseclass to implement INotifyPropertyChanged.

Function: RaisePropertyChanged(System.Linq.Expressions.Expression{System.Func{System.Object}})

• Parameter exp: Lambda expression. Feks ()=>PropertyName.
  Raise PropertyChanged when a property is changed.

Function: RaisePropertyChanged(System.String)

• Parameter name: Name of changed property.
  Raise PropertyChanged with string.

Class: TreeNode`1

(Namespace: IntoTheCode.Basic)
A Element has a parent, a string value (text) and a set of sub elements.

Property: Name
Property for name.

Property: Parent
Property for parent element.

Property: ChildNodes
Property for sub elements (elements).

Function: GetValue()

• Returns: The text value.
  Get the text of this node.

Function: Nodes(System.String)

• Parameter name: The name to search for.
• Returns: A enumerable of elements.
  Find sub elements with a given name.

Function: Nodes(System.Func{`0,System.Boolean})

• Parameter predicate: The predicate to filter with.
• Returns: A enumerable of elements.
  Find sub elements with a predicate.

Function: AnyNested(System.Func{`0,System.Boolean})

• Parameter predicate: The predicate.
• Returns: A enumerable of elements.
  Find sub elements with a predicate.

Class: FlatBuffer

(Namespace: IntoTheCode.Buffer)

Inherits IntoTheCode.Buffer.TextBuffer

Class: CommentElement

(Namespace: IntoTheCode)

Inherits IntoTheCode.CodeElement
Comments from the Text.

Class: ParserException

(Namespace: IntoTheCode)
Error when the input doesn't match the Grammar.

Constructor(System.String)

• Parameter msg: The message.
  Creator.

Class: HardElement

(Namespace: IntoTheCode.Read)

Inherits IntoTheCode.TextElement
A hard coded element.

Class: MetaParser

(Namespace: IntoTheCode.Read)
The meta-grammar for proces grammar definitions. The Instance property is a singleton parser of grammares. This class contains a hard coded parser and a string MetaGrammer, to build rules of the meta parser.

Property: SoftMetaGrammarAndSettings
The meta grammar for proces other grammares.

Property: MetaGrammar
The meta grammar for proces other grammares.

Property: MetaSettings
The settings of meta grammar.

Constructor()
A linked grammar for EBNF.

Class: ParserBuilder

(Namespace: IntoTheCode.Read)
Build Grammar elements for a parser from dokument

Function: BuildRules(IntoTheCode.Parser,IntoTheCode.CodeDocument,IntoTheCode.Read.ParserStatus)

Function: InitializeGrammar(IntoTheCode.Parser,System.Collections.Generic.List{IntoTheCode.Read.Structure.Rule},IntoTheCode.Read.ParserStatus)

• Parameter parser: The parser.
• Parameter rules: Set of rules.
• Parameter status: The parser status.
• Returns: True: no error. False: error.
  Initialize rules and elements. Called when creating a new parser and when cloning grammar.

Function: InitializeElements(System.Collections.Generic.IEnumerable{IntoTheCode.Read.ParserElementBase},System.Collections.Generic.List{IntoTheCode.Read.Structure.Rule},IntoTheCode.Read.ParserStatus)

• Parameter elements: Elements to Initialize.
• Parameter rules: Set of rules.
• Parameter status: The parser status.
  Initialize rules and elements. Called when creating a new parser and when cloning grammar.

Function: InitializeResolve(System.Collections.Generic.List{IntoTheCode.Read.Structure.Rule},IntoTheCode.Read.Structure.RuleLink,IntoTheCode.Read.ParserStatus)

• Parameter rules:
• Parameter link:
• Parameter status:
• Returns:
  Find the rule to a RuleLink.

Function: ApplySettingsFromGrammar(IntoTheCode.Parser,IntoTheCode.CodeDocument,IntoTheCode.Read.ParserStatus)

• Returns:
  Apply settings to a linked Grammar.

Function: ValidateGrammar(IntoTheCode.Parser,IntoTheCode.Read.ParserStatus)

• Returns:
  Apply settings to a linked Grammar.

Class: ParserElementBase

(Namespace: IntoTheCode.Read)

Inherits
A basic element (or symbol) of a Grammar. Can read a peace of code/text.

Function: CloneForParse(IntoTheCode.Buffer.TextBuffer)

• Parameter proces: The load proces.
• Returns: The new clone.
  Clone this parser element, with sub elements, and set proces.

Function: SetProperty(IntoTheCode.CodeElement,System.String,IntoTheCode.Read.ParserStatus)

• Parameter property: CodeElement with property name.
• Parameter value: Value string.
• Parameter status: If error add to this.
• Returns: True: property set. False: not set.
  Override this to set a property from grammar.

Function: SetPointerBack(System.Int32)

• Parameter txtPtr: Pointer to set.
• Returns: Always return false.
  If the element cant read; use this to reset (set pointer back):

Function: Load(System.Collections.Generic.List{IntoTheCode.TextElement},System.Int32)

• Parameter outElements: Read elements.
• Parameter level: Level of rules.
• Returns: True = succes.
  Load/read an element from the buffer, and increase the buffer pointer if element is ok. Insert output in 'outElements'. If loading fails the buffer pointer must be set back to previus point. The Buffer.Status.UnambiguousPointer is a point of no return. If the buffer pointer is set back before 'UnambiguousPointer'. Errors must be resolved.

Function: ResolveErrorsLast(IntoTheCode.CodeElement,System.Int32)

• Parameter last: Not null, not empty.
• Parameter level: Level of rules.
• Returns: 0: Not found, 1: Found-read error, 2: Found and read ok.
  Find the Rule/ 'read element', that correspond to the last CodeElement, and read it again with error resolving. These recursive functions are initialy called from the parser (or a SetOfElements), when the parsing is failed without any identified errors. The unfinished part of the CodeDocument is used to pin whitch element was the last to succeed AND reestablish a belonging chain of recursive calls. From that point errors is tracked with the LoadTrackError function.

Function: ResolveErrorsForward(System.Int32)

• Returns: True = no error.
  Find errors in following syntax.

Function: InitializeLoop(System.Collections.Generic.List{IntoTheCode.Read.Structure.Rule},System.Collections.Generic.List{IntoTheCode.Read.ParserElementBase},IntoTheCode.Read.ParserStatus)

• Parameter rules: Build list of analysed rules.
• Parameter path: The path to the current element; only rules and RuleLinks.
• Parameter status:
• Returns: True: one path has an ending.
  Find which RuleLinks are recursive. Called by the ParserFactory after Initializing grammar. Each path though the grammar must be followed, and each rule must have an ending.

Function: InitializeLoopHasWord(IntoTheCode.Read.Structure.RuleLink,System.Collections.Generic.List{IntoTheCode.Read.Structure.RuleLink},System.Boolean@)

• Parameter link: The RuleLink.
• Returns: 0: Link found (No words). 1: Mandatory word before link. 2: No words, no link.
  Find out if there is a mandatory word before a recursive RuleLink.

Class: Expression

(Namespace: IntoTheCode.Read.Structure)

Inherits IntoTheCode.Read.Structure.Or
Expressions read strings like this 'a + b * - c * ( 2 + d )' (Infix notation). The expression rule must look like this "expr = mul | sum | value". Or like this (inline) : "expr = expr '' expr | value;". It is a list of alternatives. The first alternative must be a binary operator. At least one alternative must be something else; not recursive. The binary operator rules must have this form: "sum = expr '+' expr". Where '+' is the operator. The default precedence are determined by the order of the operators in the expression rule. First operator has highest precedence. The operator precedence can be changed by setting the 'precedence' property. Operators are default left associative. If an operator is right associative set the 'RightAssociative' property. Output: The output tree is nested operator elements; An operator has to values elements. A value elements can be a new operator element or one of the other alternatives.*

Constructor(IntoTheCode.Read.Structure.Rule,IntoTheCode.Read.Structure.Or)
Create the Expression from the alternatives in an Or object.

Function: SetPrecedence()
Set precedence for binary operators. Operators with precendence set are ordered by this. Operators without precedence are ordered according to the position in syntax.

Function: GetSettings(System.Collections.Generic.List{System.Tuple{System.String,System.String}})

• Parameter settings:
  Get Precedence and 'RightAssociative' for operators.

Function: LoadValue(System.Collections.Generic.List{IntoTheCode.TextElement},System.Int32,System.Boolean)

• Parameter operations: The value is added to this list.
• Parameter level: Level of rule links.
• Returns: True if succes.
  Load a value. Inclusive const, variables and unary operators.

Function: LoadBinaryOperator(System.Collections.Generic.List{IntoTheCode.TextElement},System.Int32)

• Parameter outElements: The value is added to this list.
• Parameter level: Level of rule links.
• Returns: True if succes.
  Load a binary operator.

Function: ResolveErrorsLast(IntoTheCode.CodeElement,System.Int32)

• Returns: 0: Not found, 1: Found-read error, 2: Found and read ok. Function: ResolveErrorsForwardValue(System.Int32,System.Boolean)

• Parameter operations: The value is added to this list.

• Parameter level: Level of rule links.
• Returns: True if succes.
  ResolveErrorsForward a value. Inclusive const, variables and unary operators.

Function: ResolveErrorsForwardBinaryOperator(System.Int32)

• Parameter outElements: The value is added to this list.
• Parameter level: Level of rule links.
• Returns: True if succes.
  ResolveErrorsForward a binary operator.

Class: Optional

(Namespace: IntoTheCode.Read.Structure)

Inherits IntoTheCode.Read.Structure.SetOfElementsBase

Constructor(IntoTheCode.Read.ParserElementBase[])
Creator for .

Function: ResolveErrorsLast(IntoTheCode.CodeElement,System.Int32)

• Parameter last: Not null, not empty.
• Returns: 0: Not found, 1: Found-read error, 2: Found and read ok.
  Find the Rule/ 'read element', that correspond to the last CodeElement, and read it again with error resolving. If no error, try to read further.

Class: Or

(Namespace: IntoTheCode.Read.Structure)

Inherits IntoTheCode.Read.ParserElementBase

Constructor(IntoTheCode.Read.ParserElementBase,IntoTheCode.Read.ParserElementBase)
Creator for .

Function: ResolveErrorsLast(IntoTheCode.CodeElement,System.Int32)

• Returns: 0: Not found, 1: Found-read error, 2: Found and read ok.

Class: Parentheses

(Namespace: IntoTheCode.Read.Structure)

Inherits IntoTheCode.Read.Structure.SetOfElements

Constructor(IntoTheCode.Read.ParserElementBase[])
Creator for .

Class: Rule

(Namespace: IntoTheCode.Read.Structure)

Inherits IntoTheCode.Read.Structure.SetOfElementsBase

Constructor(System.String,IntoTheCode.Read.ParserElementBase[])

• Parameter name:
• Parameter elements:
  Statement, Action,

Function: ResolveErrorsLast(IntoTheCode.CodeElement,System.Int32)

• Parameter last: Not null, not empty.
• Returns: 0: Not found, 1: Found-read error, 2: Found and read ok.
  Find the Rule/ 'read element', that correspond to the last CodeElement, and read it again with error resolving. If no error, try to read further.

Class: RuleLink

(Namespace: IntoTheCode.Read.Structure)

Inherits IntoTheCode.Read.ParserElementBase
Base class for Grammar symbols.

Constructor(System.String)
Creator for .

Function: ResolveErrorsLast(IntoTheCode.CodeElement,System.Int32)

• Returns: 0: Not found, 1: Found-read error, 2: Found and read ok.

Class: Sequence

(Namespace: IntoTheCode.Read.Structure)

Inherits IntoTheCode.Read.Structure.SetOfElementsBase

Constructor(IntoTheCode.Read.ParserElementBase[])
Creator for .

Constructor()
To create an unlinked Grammar.

Function: ResolveErrorsLast(IntoTheCode.CodeElement,System.Int32)

• Returns: 0: Not found, 1: Found-read error, 2: Found and read ok.

Class: SetOfElements

(Namespace: IntoTheCode.Read.Structure)

Inherits IntoTheCode.Read.Structure.SetOfElementsBase

Constructor(IntoTheCode.Read.ParserElementBase[])
Creator for .

Function: ResolveErrorsLast(IntoTheCode.CodeElement,System.Int32)

• Returns: 0: Not found, 1: Found-read error, 2: Found and read ok.

Class: SetOfElementsBase

(Namespace: IntoTheCode.Read.Structure)

Inherits IntoTheCode.Read.ParserElementBase

Constructor()
To create unlinked Grammar.

Function: ResolveSetErrorsLast(IntoTheCode.CodeElement,System.Int32)

• Parameter last: Not null, not empty.
• Returns: 0: Not found, 1: Found-read error, 2: Found and read ok.
  Find the Rule/ 'read element', that correspond to the last CodeElement, and read it again with error resolving. If no error, try to read further.

Class: WordBase

(Namespace: IntoTheCode.Read.Words)

Inherits IntoTheCode.Read.ParserElementBase
A Grammar element that can read charecters (a word).

Function: GetWord(IntoTheCode.Buffer.TextSubString)

• Parameter buf:
• Parameter ptr:
• Returns:
  Get string representation of value from buffer.

Class: WordBinaryOperator

(Namespace: IntoTheCode.Read.Words)

Inherits IntoTheCode.Read.Words.WordSymbol

Constructor(IntoTheCode.Read.Words.WordSymbol,System.String,IntoTheCode.Buffer.TextBuffer)
Creator for .

Class: WordBool

(Namespace: IntoTheCode.Read.Words)

Inherits IntoTheCode.Read.Words.WordBase

Function: ResolveErrorsLast(IntoTheCode.CodeElement,System.Int32)

• Returns: 0: Not found, 1: Found-read error, 2: Found and read ok.

Class: WordFloat

(Namespace: IntoTheCode.Read.Words)

Inherits IntoTheCode.Read.Words.WordBase

Function: ResolveErrorsLast(IntoTheCode.CodeElement,System.Int32)

• Returns: 0: Not found, 1: Found-read error, 2: Found and read ok.

Class: WordIdent

(Namespace: IntoTheCode.Read.Words)

Inherits IntoTheCode.Read.Words.WordBase

Function: ResolveErrorsLast(IntoTheCode.CodeElement,System.Int32)

• Returns: 0: Not found, 1: Found-read error, 2: Found and read ok.

Class: WordInt

(Namespace: IntoTheCode.Read.Words)

Inherits IntoTheCode.Read.Words.WordBase

Function: ResolveErrorsLast(IntoTheCode.CodeElement,System.Int32)

• Returns: 0: Not found, 1: Found-read error, 2: Found and read ok.

Class: WordString

(Namespace: IntoTheCode.Read.Words)

Inherits IntoTheCode.Read.Words.WordBase

Function: ResolveErrorsLast(IntoTheCode.CodeElement,System.Int32)

• Returns: 0: Not found, 1: Found-read error, 2: Found and read ok.

Class: WordSymbol

(Namespace: IntoTheCode.Read.Words)

Inherits IntoTheCode.Read.Words.WordBase

Property: Precedence
Only if this symbol is transformed to an binary operator.

Property: RightAssociative
Only if this symbol is transformed to an binary operator.

Function: SetProperty(IntoTheCode.CodeElement,System.String,IntoTheCode.Read.ParserStatus)

• Parameter property: CodeElement with property name.
• Parameter value: Value string.
• Parameter status: If error add to this.
• Returns: True: property set. False: not set.
  Override this to set a property from grammar.

Function: ResolveErrorsLast(IntoTheCode.CodeElement,System.Int32)

• Returns: 0: Not found, 1: Found-read error, 2: Found and read ok.

Class: TextElement

(Namespace: IntoTheCode)

Inherits
The Elements that build up a TextDokument.

Function: Codes()

• Returns: A enumerable of codes.
  Get all child code elements.

Function: Codes(System.String)

• Parameter name: The name to search for.
• Returns: A enumerable of codes.
  Find child code elements with a given name.

Function: Codes(System.Func{IntoTheCode.CodeElement,System.Boolean})

• Parameter predicate: The predicate to filter with.
• Returns: A enumerable of codes.
  Find child code elements with a predicate.