Ntp.Analyzer.Config.Syntax.SyntaxNode< T > Class Template Reference

Inheritance diagram for Ntp.Analyzer.Config.Syntax.SyntaxNode< T >:

Collaboration diagram for Ntp.Analyzer.Config.Syntax.SyntaxNode< T >:

Public Member Functions
void	Add (ISyntaxNode node)
void	Assemble (ISyntaxNode node)
T	Compile ()
void	CompileNode ()
IEnumerator< ISyntaxNode >	GetEnumerator ()
void	Resolve (SymbolTable table)
void	Validate (SymbolTable table)

Public Attributes
ConfigurationNode	CompiledNode => compiledNode
IEnumerable< string >	Errors => errors
bool	HasErrors => errors.Count != 0

Protected Member Functions
	SyntaxNode (Symbol symbol, string name, int line, bool requirePath=false)
void	AddError (string message)
void	AddReferenceNameError (ISyntaxNode node, string keyword, string name)
void	AddReferenceTypeError (ISyntaxNode node, string keyword, string section, string name)
void	CheckAllIsPresent (IEnumerable< Symbol > list)
void	CheckIsUnique (IEnumerable< Symbol > list)
Uri	CheckLink (string link, string keyword)
void	CheckOneIsPresent (IEnumerable< Symbol > list)
void	CheckOnlyOneIsPresent (IEnumerable< Symbol > list)
void	CheckTypeIs< TU > (Symbol symbol)
void	CheckTypeIs< TU, TV > (Symbol symbol)
abstract T	InternalCompile ()
virtual void	InternalResolve (SymbolTable table)
	Override to resolve references to other syntax nodes from this syntax node. More...
virtual void	ValidateMandatories ()
	Override to validates the mandatory types in this syntax node. More...
virtual void	ValidateReferences (SymbolTable table)
	Override to validates the references in this syntax node. More...
virtual void	ValidateTypes ()
	Override to validates the types in this syntax node. More...

Properties
int	Line [get]
string	Name [get]
List< ISyntaxNode >	Nodes [get]
bool	RequirePath [get]
Symbol	Symbol [get]
Properties inherited from Ntp.Analyzer.Config.Syntax.ISyntaxNode
ConfigurationNode	CompiledNode [get]
IEnumerable< string >	Errors [get]
bool	HasErrors [get]
int	Line [get]
bool	RequirePath [get]
Symbol	Symbol [get]

Private Member Functions
IEnumerator IEnumerable.	GetEnumerator ()

Private Attributes
T	compiledNode
readonly List< string >	errors

Detailed Description

Type Constraints

T

:

ConfigurationNode

Definition at line 33 of file SyntaxNode.cs.

Constructor & Destructor Documentation

Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.SyntaxNode ( Symbol  symbol, string  name, int  line, bool  requirePath = false  )

inlineprotected

Definition at line 36 of file SyntaxNode.cs.

        {
            Symbol = symbol;
            Name = name;
            Line = line;
            RequirePath = requirePath;
            compiledNode = null;
            Nodes = new List<ISyntaxNode>();
            errors = new List<string>();
        }

Member Function Documentation

void Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.Add ( ISyntaxNode< T >  node )

inline

Implements Ntp.Analyzer.Config.Syntax.ISyntaxNode.

Definition at line 66 of file SyntaxNode.cs.

Referenced by Ntp.Analyzer.Config.Syntax.GraphSetSyntaxNode.InternalCompile(), and Ntp.Analyzer.Config.Compiler.ConfigParser.ParseOption< T >().

        {
            Nodes.Add(node);
        }

Here is the caller graph for this function:

void Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.AddError ( string  message )

inlineprotected

Definition at line 454 of file SyntaxNode.cs.

        {
            errors.Add(message);
        }

void Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.AddReferenceNameError ( ISyntaxNode< T >  node, string  keyword, string  name  )

inlineprotected

Definition at line 428 of file SyntaxNode.cs.

        {
            var b = new StringBuilder();
            if (Line != 0)
            {
                b.Append("Error in line ");
                b.Append(node.Line);
                b.Append(": ");
            }
            b.Append($"{keyword} {name} refers to a nonexistent section.");
            AddError(b.ToString());
        }

void Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.AddReferenceTypeError ( ISyntaxNode< T >  node, string  keyword, string  section, string  name  )

inlineprotected

Definition at line 441 of file SyntaxNode.cs.

        {
            var b = new StringBuilder();
            if (node.Line != 0)
            {
                b.Append("Error in line ");
                b.Append(node.Line);
                b.Append(": ");
            }
            b.Append($"{keyword} {name} does not refer to a {section} section.");
            AddError(b.ToString());
        }

void Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.Assemble ( ISyntaxNode< T >  node )

inline

Implements Ntp.Analyzer.Config.Syntax.ISyntaxNode.

Definition at line 98 of file SyntaxNode.cs.

        {
            if (compiledNode == null)
                return;

            compiledNode.Parent = node.CompiledNode;
            node.CompiledNode.Assemble();
        }

void Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.CheckAllIsPresent ( IEnumerable< Symbol >  list )

inlineprotected

Definition at line 205 of file SyntaxNode.cs.

        {
            var missing = list.
                Where(item => Nodes.Count(n => n.Symbol == item) == 0).
                ToList();

            if (missing.Count == 0)
                return;

            // Build error message
            int i = 0;
            int count = missing.Count;
            var b = new StringBuilder();

            if (Line != 0)
            {
                b.Append("Error in line ");
                b.Append(Line);
                b.Append(": ");
            }
            b.Append(Keyword.Find(Symbol).Name);
            b.Append(" section is missing the setting");
            b.Append(missing.Count > 1 ? "s: " : ": ");

            foreach (var item in missing)
            {
                i++;
                b.Append(Keyword.Find(item).Name);
                if (i == count - 1 && count > 1)
                {
                    b.Append(" and ");
                }
                else if (i != count)
                {
                    b.Append(", ");
                }
                else
                {
                    b.Append(".");
                }
            }

            errors.Add(b.ToString());
        }

void Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.CheckIsUnique ( IEnumerable< Symbol >  list )

inlineprotected

Definition at line 340 of file SyntaxNode.cs.

        {
            var nonUniques = (
                from symbol in list
                let c = Nodes.Count(n => n.Symbol == symbol)
                where c > 1
                select symbol
                ).ToList();

            if (nonUniques.Count == 0)
                return;

            // Build error message
            int i = 0;
            int count = nonUniques.Count;
            var b = new StringBuilder();

            if (Line != 0)
            {
                b.Append("Error in line ");
                b.Append(Line);
                b.Append(": ");
            }
            b.Append(Keyword.Find(Symbol).Name);
            b.Append(" section has multiple occurrences of the setting");
            b.Append(count > 1 ? "s: " : ": ");

            foreach (var item in nonUniques)
            {
                i++;
                b.Append(Keyword.Find(item).Name);
                if (i == count - 1)
                {
                    b.Append(" and ");
                }
                else if (i != count)
                {
                    b.Append(", ");
                }
                else
                {
                    b.Append(".");
                }
            }

            errors.Add(b.ToString());
        }

Uri Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.CheckLink ( string  link, string  keyword  )

inlineprotected

Definition at line 388 of file SyntaxNode.cs.

        {
            if (link == null)
                return null;

            Uri uri;
            string text = link.TrimStart();

            if ((text.StartsWith("http://") ||
                 text.StartsWith("https://") ||
                 text.StartsWith("ftp://") ||
                 text.StartsWith("mailto:") ||
                 text.StartsWith("javascript:")) &&
                Uri.TryCreate(link, UriKind.Absolute, out uri))
                return uri;

            if (Uri.TryCreate("/" + link.TrimStart('/'), UriKind.Relative, out uri))
                return uri;

            if (Uri.TryCreate(link, UriKind.Absolute, out uri))
                return uri;

            var name = Keyword.Find(Symbol).Name;
            var b = new StringBuilder();
            if (Line != 0)
            {
                b.Append("Error in line ");
                b.Append(Line);
                b.Append(": ");
            }
            b.Append($"{keyword} {name} is not a wellformed link.");
            AddError(b.ToString());

            return null;
        }

void Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.CheckOneIsPresent ( IEnumerable< Symbol >  list )

inlineprotected

Definition at line 250 of file SyntaxNode.cs.

        {
            var symbols = list as IList<Symbol> ?? list.ToList();
            var set = new HashSet<Symbol>(symbols);

            if (Nodes.Any(node => set.Contains(node.Symbol)))
                return;

            // Build error message
            int i = 0;
            int count = symbols.Count;
            var b = new StringBuilder();

            if (Line != 0)
            {
                b.Append("Error in line ");
                b.Append(Line);
                b.Append(": ");
            }
            b.Append(Keyword.Find(Symbol).Name);
            b.Append(" section must contain at least one of the setting");
            b.Append(count > 1 ? "s: " : ": ");

            foreach (var item in symbols)
            {
                i++;
                b.Append(Keyword.Find(item).Name);
                if (i == count - 1)
                {
                    b.Append(" or ");
                }
                else if (i != count)
                {
                    b.Append(", ");
                }
                else
                {
                    b.Append(".");
                }
            }

            errors.Add(b.ToString());
        }

void Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.CheckOnlyOneIsPresent ( IEnumerable< Symbol >  list )

inlineprotected

Definition at line 294 of file SyntaxNode.cs.

        {
            var symbols = list.ToList();
            var set = new HashSet<Symbol>(symbols);

            int a = Nodes.Count(node => set.Contains(node.Symbol));

            if (a < 2)
                return;

            // Build error message
            int i = 0;
            int count = symbols.Count;
            var b = new StringBuilder();

            if (Line != 0)
            {
                b.Append("Error in line ");
                b.Append(Line);
                b.Append(": ");
            }
            b.Append(Keyword.Find(Symbol).Name);
            b.Append(" section can only contain one of the setting");
            b.Append(count > 1 ? "s: " : ": ");

            foreach (var item in symbols)
            {
                i++;
                b.Append(Keyword.Find(item).Name);
                if (i == count - 1)
                {
                    b.Append(" or ");
                }
                else if (i != count)
                {
                    b.Append(", ");
                }
                else
                {
                    b.Append(".");
                }
            }

            errors.Add(b.ToString());
        }

void Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.CheckTypeIs< TU > ( Symbol  symbol )

inlineprotected

Type Constraints

TU	:	SettingNode
TU	:	new()

Definition at line 154 of file SyntaxNode.cs.

                     : SettingNode, new()
        {
            foreach (var node in Nodes.Where(n => n.Symbol == symbol))
            {
                if (node is TU)
                    continue;

                // Build error message
                var b = new StringBuilder();
                if (Line != 0)
                {
                    b.Append("Error in line ");
                    b.Append(Line);
                    b.Append(": ");
                }
                b.Append("Value of setting ");
                b.Append(Keyword.Find(symbol).Name);
                b.Append(" must be ");
                b.Append(new TU().SettingValue);
                errors.Add(b.ToString());
            }
        }

void Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.CheckTypeIs< TU, TV > ( Symbol  symbol )

inlineprotected

Type Constraints

TU	:	SettingNode
TU	:	new()
TV	:	SettingNode
TV	:	new()

Definition at line 178 of file SyntaxNode.cs.

                     : SettingNode, new()
            where TV : SettingNode, new()
        {
            foreach (var node in Nodes.Where(n => n.Symbol == symbol))
            {
                if (node is TU || node is TV)
                    continue;

                // Build error message
                var b = new StringBuilder();
                if (Line != 0)
                {
                    b.Append("Error in line ");
                    b.Append(Line);
                    b.Append(": ");
                }
                b.Append("Value of setting ");
                b.Append(Keyword.Find(symbol).Name);
                b.Append(" must be ");
                b.Append(new TU().SettingValue);
                b.Append(" or ");
                b.Append(new TV().SettingValue);
                errors.Add(b.ToString());
            }
        }

T Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.Compile ( )

inline

Definition at line 107 of file SyntaxNode.cs.

Referenced by Ntp.Analyzer.Config.Syntax.HostGraphPageSyntaxNode.InternalCompile(), Ntp.Analyzer.Config.Syntax.PeerGraphPageSyntaxNode.InternalCompile(), Ntp.Analyzer.Config.Syntax.PeerSummaryPageSyntaxNode.InternalCompile(), and Ntp.Analyzer.Config.Syntax.HostPageSyntaxNode.InternalCompile().

        {
            return compiledNode ?? (compiledNode = InternalCompile());
        }

Here is the caller graph for this function:

void Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.CompileNode ( )

inline

Implements Ntp.Analyzer.Config.Syntax.ISyntaxNode.

Definition at line 81 of file SyntaxNode.cs.

        {
            Compile();
        }

IEnumerator<ISyntaxNode> Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.GetEnumerator ( )

inline

Definition at line 71 of file SyntaxNode.cs.

        {
            return Nodes.GetEnumerator();
        }

IEnumerator IEnumerable. Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.GetEnumerator ( )

inlineprivate

Definition at line 76 of file SyntaxNode.cs.

        {
            return GetEnumerator();
        }

abstract T Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.InternalCompile ( )

protectedpure virtual

Implemented in Ntp.Analyzer.Config.Syntax.MenuItemSyntaxNode, Ntp.Analyzer.Config.Syntax.Setting.SettingNode, Ntp.Analyzer.Config.Syntax.GraphSetSyntaxNode, Ntp.Analyzer.Config.Syntax.HostPageSyntaxNode, Ntp.Analyzer.Config.Syntax.PeerSummaryPageSyntaxNode, Ntp.Analyzer.Config.Syntax.PermissionSyntaxNode, Ntp.Analyzer.Config.Syntax.AboutPageSyntaxNode, Ntp.Analyzer.Config.Syntax.HostGraphPageSyntaxNode, Ntp.Analyzer.Config.Syntax.HostSyntaxNode, Ntp.Analyzer.Config.Syntax.PeerGraphPageSyntaxNode, Ntp.Analyzer.Config.Syntax.PeerPageSyntaxNode, Ntp.Analyzer.Config.Syntax.StatSyntaxNode, Ntp.Analyzer.Config.Syntax.SummariesSyntaxNode, Ntp.Analyzer.Config.Syntax.DatabaseSyntaxNode, Ntp.Analyzer.Config.Syntax.LogSyntaxNode, Ntp.Analyzer.Config.Syntax.DirDestinationSyntaxNode, Ntp.Analyzer.Config.Syntax.FileDestinationSyntaxNode, Ntp.Analyzer.Config.Syntax.HostGraphSyntaxNode, Ntp.Analyzer.Config.Syntax.PeerGraphSyntaxNode, Ntp.Analyzer.Config.Syntax.ReadingSyntaxNode, Ntp.Analyzer.Config.Syntax.TrafficGraphSyntaxNode, Ntp.Analyzer.Config.Syntax.WebLinkSyntaxNode, Ntp.Analyzer.Config.Syntax.HeartbeatSyntaxNode, Ntp.Analyzer.Config.Syntax.ListenerSyntaxNode, Ntp.Analyzer.Config.Syntax.NotifySyntaxNode, Ntp.Analyzer.Config.Syntax.MenuSyntaxNode, and Ntp.Analyzer.Config.Syntax.RootSyntaxNode.

virtual void Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.InternalResolve ( SymbolTable  table )

inlineprotectedvirtual

Override to resolve references to other syntax nodes from this syntax node.

When overriding this method do not call the base method.

Parameters

table

Table.

Definition at line 146 of file SyntaxNode.cs.

        {
        }

void Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.Resolve ( SymbolTable  table )

inline

Implements Ntp.Analyzer.Config.Syntax.ISyntaxNode.

Definition at line 86 of file SyntaxNode.cs.

        {
            InternalResolve(table);
        }

void Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.Validate ( SymbolTable  table )

inline

Implements Ntp.Analyzer.Config.Syntax.ISyntaxNode.

Definition at line 91 of file SyntaxNode.cs.

        {
            ValidateTypes();
            ValidateMandatories();
            ValidateReferences(table);
        }

virtual void Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.ValidateMandatories ( )

inlineprotectedvirtual

Override to validates the mandatory types in this syntax node.

When overriding this method do not call the base method.

Reimplemented in Ntp.Analyzer.Config.Syntax.PermissionSyntaxNode, Ntp.Analyzer.Config.Syntax.MenuItemSyntaxNode, Ntp.Analyzer.Config.Syntax.HostSyntaxNode, Ntp.Analyzer.Config.Syntax.TrafficGraphSyntaxNode, Ntp.Analyzer.Config.Syntax.DatabaseSyntaxNode, Ntp.Analyzer.Config.Syntax.GraphSetSyntaxNode, Ntp.Analyzer.Config.Syntax.HostPageSyntaxNode, Ntp.Analyzer.Config.Syntax.StatSyntaxNode, Ntp.Analyzer.Config.Syntax.HostGraphSyntaxNode, Ntp.Analyzer.Config.Syntax.PeerGraphSyntaxNode, Ntp.Analyzer.Config.Syntax.NotifySyntaxNode, Ntp.Analyzer.Config.Syntax.PeerSummaryPageSyntaxNode, Ntp.Analyzer.Config.Syntax.AboutPageSyntaxNode, Ntp.Analyzer.Config.Syntax.HostGraphPageSyntaxNode, Ntp.Analyzer.Config.Syntax.PeerGraphPageSyntaxNode, Ntp.Analyzer.Config.Syntax.PeerPageSyntaxNode, Ntp.Analyzer.Config.Syntax.RootSyntaxNode, Ntp.Analyzer.Config.Syntax.LogSyntaxNode, Ntp.Analyzer.Config.Syntax.ReadingSyntaxNode, Ntp.Analyzer.Config.Syntax.SummariesSyntaxNode, Ntp.Analyzer.Config.Syntax.DirDestinationSyntaxNode, Ntp.Analyzer.Config.Syntax.ListenerSyntaxNode, Ntp.Analyzer.Config.Syntax.FileDestinationSyntaxNode, Ntp.Analyzer.Config.Syntax.WebLinkSyntaxNode, Ntp.Analyzer.Config.Syntax.HeartbeatSyntaxNode, and Ntp.Analyzer.Config.Syntax.MenuSyntaxNode.

Definition at line 128 of file SyntaxNode.cs.

        {
        }

virtual void Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.ValidateReferences ( SymbolTable  table )

inlineprotectedvirtual

Override to validates the references in this syntax node.

When overriding this method do not call the base method.

Parameters

table

Table.

Definition at line 137 of file SyntaxNode.cs.

        {
        }

virtual void Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.ValidateTypes ( )

inlineprotectedvirtual

Override to validates the types in this syntax node.

When overriding this method do not call the base method.

Reimplemented in Ntp.Analyzer.Config.Syntax.NotifySyntaxNode, Ntp.Analyzer.Config.Syntax.MenuItemSyntaxNode, Ntp.Analyzer.Config.Syntax.TrafficGraphSyntaxNode, Ntp.Analyzer.Config.Syntax.DatabaseSyntaxNode, Ntp.Analyzer.Config.Syntax.HostPageSyntaxNode, Ntp.Analyzer.Config.Syntax.StatSyntaxNode, Ntp.Analyzer.Config.Syntax.PeerSummaryPageSyntaxNode, Ntp.Analyzer.Config.Syntax.HostSyntaxNode, Ntp.Analyzer.Config.Syntax.GraphSetSyntaxNode, Ntp.Analyzer.Config.Syntax.HostGraphSyntaxNode, Ntp.Analyzer.Config.Syntax.PeerGraphSyntaxNode, Ntp.Analyzer.Config.Syntax.HostGraphPageSyntaxNode, Ntp.Analyzer.Config.Syntax.PeerGraphPageSyntaxNode, Ntp.Analyzer.Config.Syntax.PermissionSyntaxNode, Ntp.Analyzer.Config.Syntax.AboutPageSyntaxNode, Ntp.Analyzer.Config.Syntax.PeerPageSyntaxNode, Ntp.Analyzer.Config.Syntax.SummariesSyntaxNode, Ntp.Analyzer.Config.Syntax.LogSyntaxNode, Ntp.Analyzer.Config.Syntax.ReadingSyntaxNode, Ntp.Analyzer.Config.Syntax.ListenerSyntaxNode, Ntp.Analyzer.Config.Syntax.DirDestinationSyntaxNode, Ntp.Analyzer.Config.Syntax.WebLinkSyntaxNode, Ntp.Analyzer.Config.Syntax.FileDestinationSyntaxNode, and Ntp.Analyzer.Config.Syntax.HeartbeatSyntaxNode.

Definition at line 120 of file SyntaxNode.cs.

        {
        }

Member Data Documentation

T Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.compiledNode

private

Definition at line 48 of file SyntaxNode.cs.

ConfigurationNode Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.CompiledNode => compiledNode

Definition at line 64 of file SyntaxNode.cs.

readonly List<string> Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.errors

private

Definition at line 47 of file SyntaxNode.cs.

IEnumerable<string> Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.Errors => errors

Definition at line 62 of file SyntaxNode.cs.

bool Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.HasErrors => errors.Count != 0

Definition at line 60 of file SyntaxNode.cs.

Property Documentation

int Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.Line

get

Definition at line 58 of file SyntaxNode.cs.

string Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.Name

getprotected

Definition at line 52 of file SyntaxNode.cs.

List<ISyntaxNode> Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.Nodes

getprotected

Definition at line 50 of file SyntaxNode.cs.

bool Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.RequirePath

get

Definition at line 56 of file SyntaxNode.cs.

Symbol Ntp.Analyzer.Config.Syntax.SyntaxNode< T >.Symbol

get

Definition at line 54 of file SyntaxNode.cs.

Referenced by Ntp.Analyzer.Config.Compiler.ConfigParser.ParseMenuItemType().

---

The documentation for this class was generated from the following file:

• Ntp.Analyzer/Config/Syntax/SyntaxNode.cs