Implements a Meta Data container for an expression. More...

Inheritance diagram for BadScript2.Parser.BadMetaData:

Public Member Functions

BadMetaData (string description, string returnDescription, string returnType, Dictionary< string, BadParameterMetaData > parameterDescriptions)

Creates a new Meta Data Object.

override BadClassPrototype GetPrototype ()

override bool HasProperty (string propName, BadScope? caller=null)

Returns true if the object contains a given property or there exists an extension for the current Instance.

Parameters

propName	The Property Name
caller	The caller Scope

Returns: True if the Property or an Extension with that name exists

override BadObjectReference GetProperty (string propName, BadScope? caller=null)

Returns a Reference to the Property with the given Name.

Parameters

propName	The Property Name
caller	The caller Scope

Returns: The Property Reference

override string ToSafeString (List< BadObject > done)

Public Member Functions inherited from BadScript2.Runtime.Objects.BadObject

BadClassPrototype GetPrototype ()

Returns the Prototype of this Object.

string ToSafeString (List< BadObject > done)

Returns a String Representation of this Object. This function is recursion proof and supports circular references.

override string ToString ()

Returns a String Representation of this Object.

Public Attributes
readonly string	Description
	The Description of the Expression.

readonly Dictionary< string, BadParameterMetaData >	ParameterDescriptions
	The Description of the Function Parameters.

readonly string	ReturnDescription
	The Description of the Return Value.

readonly string	ReturnType
	The Return Type of the Expression.

Static Public Attributes
static readonly BadMetaData	Empty
	An empty Meta Data object.

Static Public Attributes inherited from BadScript2.Runtime.Objects.BadObject
static readonly BadObject	Null = new BadNullObject()
	The Null Value for the BadScript Language.

static readonly BadObject	True = new BadBoolean(true)
	The True Value for the BadScript Language.

static readonly BadObject	False = new BadBoolean(false)
	The False Value for the BadScript Language.

Additional Inherited Members
Static Public Member Functions inherited from BadScript2.Runtime.Objects.BadObject
static bool	CanWrap (object? o)
	Returns true if the given object cam be wrapped.

static BadObject	Wrap< T > (T obj, bool allowNative=true)
	Wraps the given object into a BadObject Instance.

static implicit	operator BadObject (bool b)
	Implicit Converstion from Boolean to BadObject.

static implicit	operator BadObject (BadNullable< bool > b)
	Converts the given object to a BadObject Instance.

static implicit	operator BadObject (DateTimeOffset d)

static implicit	operator BadObject (TimeSpan t)

static implicit	operator BadObject (decimal d)
	Implicit Converstion from Number to BadObject.

static implicit	operator BadObject (BadNullable< decimal > b)
	Converts the given object to a BadObject Instance.

static implicit	operator BadObject (string s)
	Implicit Converstion from String to BadObject.

static implicit	operator BadObject (BadNullable< string > b)
	Converts the given object to a BadObject Instance.

Detailed Description

Implements a Meta Data container for an expression.

Definition at line 15 of file BadMetaData.cs.

Constructor & Destructor Documentation

◆ BadMetaData()

BadScript2.Parser.BadMetaData.BadMetaData	(	string	description,
		string	returnDescription,
		string	returnType,
		Dictionary< string, BadParameterMetaData >	parameterDescriptions
	)

Creates a new Meta Data Object.

Parameters

description	The Description of the Expression
returnDescription	The Description of the Return Value
returnType	The Return Type of the Expression
parameterDescriptions	The Description of the Function Parameters

Definition at line 50 of file BadMetaData.cs.

    {
        Description = description;
        ReturnDescription = returnDescription;
        ParameterDescriptions = parameterDescriptions;
        ReturnType = returnType;
    }

Member Function Documentation

◆ GetProperty()

override BadObjectReference BadScript2.Parser.BadMetaData.GetProperty	(	string	propName,
		BadScope?	caller = `null`
	)

virtual

Returns a Reference to the Property with the given Name.

Parameters

propName	The Property Name
caller	The caller Scope

Returns: The Property Reference

Reimplemented from BadScript2.Runtime.Objects.BadObject.

Definition at line 75 of file BadMetaData.cs.

    {
        switch (propName)
        {
            case "Description":
                return BadObjectReference.Make("BadMetaData.Description", (p) => Description);
            case "Return":
                return BadObjectReference.Make("BadMetaData.Return",
                                               (p) => new BadTable(new Dictionary<string, BadObject>
                                                                  {
                                                                      { "Type", ReturnType },
                                                                      { "Description", ReturnDescription },
                                                                  }
                                                                 )
                                              );
            case "Parameters":
                return BadObjectReference.Make("BadMetaData.Parameters",
                                               (p) => new BadTable(ParameterDescriptions.ToDictionary(x => x.Key,
                                                                       x => (BadObject)
                                                                           new BadTable(new Dictionary<string,
                                                                                       BadObject>
                                                                                   {
                                                                                       { "Type", x.Value.Type },
                                                                                       {
                                                                                           "Description",
                                                                                           x.Value.Description
                                                                                       },
                                                                                   }
                                                                               )
                                                                      )
                                                                 )
                                              );
        }
 
        return base.GetProperty(propName, caller);
    }

◆ GetPrototype()

override BadClassPrototype BadScript2.Parser.BadMetaData.GetPrototype ( )

Definition at line 62 of file BadMetaData.cs.

    {
        throw new NotSupportedException();
    }

◆ HasProperty()

override bool BadScript2.Parser.BadMetaData.HasProperty	(	string	propName,
		BadScope?	caller = `null`
	)

virtual

Returns true if the object contains a given property or there exists an extension for the current Instance.

Parameters

propName	The Property Name
caller	The caller Scope

Returns: True if the Property or an Extension with that name exists

Reimplemented from BadScript2.Runtime.Objects.BadObject.

Definition at line 68 of file BadMetaData.cs.

    {
        return propName is "Description" or "Return" or "Parameters" ||
               base.HasProperty(propName, caller);
    }

◆ ToSafeString()

override string BadScript2.Parser.BadMetaData.ToSafeString ( List< BadObject > done )

Definition at line 113 of file BadMetaData.cs.

    {
        StringBuilder sb = new StringBuilder();
 
        sb.AppendLine(Description);
 
        foreach (KeyValuePair<string, BadParameterMetaData> kv in ParameterDescriptions)
        {
            sb.AppendLine($"Parameter {kv.Key} {kv.Value.Type}: {kv.Value.Description}");
        }
 
        sb.AppendLine("Returns: " + ReturnDescription);
 
        return sb.ToString();
    }

Member Data Documentation

◆ Description

readonly string BadScript2.Parser.BadMetaData.Description

The Description of the Expression.

Definition at line 26 of file BadMetaData.cs.

◆ Empty

readonly BadMetaData BadScript2.Parser.BadMetaData.Empty

static

Initial value:

=

new BadMetaData("", "", "any", new Dictionary<string, BadParameterMetaData>())

BadScript2.Parser.BadMetaData.BadMetaData

BadMetaData(string description, string returnDescription, string returnType, Dictionary< string, BadParameterMetaData > parameterDescriptions)

Creates a new Meta Data Object.

Definition BadMetaData.cs:50

An empty Meta Data object.

Definition at line 20 of file BadMetaData.cs.

◆ ParameterDescriptions

readonly Dictionary<string, BadParameterMetaData> BadScript2.Parser.BadMetaData.ParameterDescriptions

The Description of the Function Parameters.

Definition at line 31 of file BadMetaData.cs.

◆ ReturnDescription

readonly string BadScript2.Parser.BadMetaData.ReturnDescription

The Description of the Return Value.

Definition at line 36 of file BadMetaData.cs.

◆ ReturnType

readonly string BadScript2.Parser.BadMetaData.ReturnType

The Return Type of the Expression.

Definition at line 41 of file BadMetaData.cs.

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

src/BadScript2/Parser/BadMetaData.cs

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BadMetaData()

Member Function Documentation

◆ GetProperty()

◆ GetPrototype()

◆ HasProperty()

◆ ToSafeString()

Member Data Documentation

◆ Description

◆ Empty

◆ ParameterDescriptions

◆ ReturnDescription

◆ ReturnType