Syntax.h

Go to the documentation of this file.

//
// Copyright Contributors to the MaterialX Project
// SPDX-License-Identifier: Apache-2.0
//
 
#ifndef MATERIALX_SYNTAX_H
#define MATERIALX_SYNTAX_H

 
#include <MaterialXGenShader/Export.h>
#include <MaterialXGenShader/TypeDesc.h>
 
#include <MaterialXCore/Definition.h>
#include <MaterialXCore/Library.h>
#include <MaterialXCore/Value.h>
 
MATERIALX_NAMESPACE_BEGIN
 
class Syntax;
class TypeSyntax;
class StructTypeSyntax;
class TypeDesc;
class ShaderPort;

using SyntaxPtr = shared_ptr<Syntax>;
using ConstSyntaxPtr = shared_ptr<const Syntax>;
using TypeSyntaxPtr = shared_ptr<TypeSyntax>;
using StructTypeSyntaxPtr = shared_ptr<StructTypeSyntax>;

using IdentifierMap = std::unordered_map<string, size_t>;

class MX_GENSHADER_API Syntax
{
  public:
    enum Punctuation
    {
        PARENTHESES,
        CURLY_BRACKETS,
        SQUARE_BRACKETS,
        DOUBLE_SQUARE_BRACKETS
    };
 
  public:
    virtual ~Syntax() { }

    void registerTypeSyntax(TypeDesc type, TypeSyntaxPtr syntax);
    [[deprecated]] void registerTypeSyntax(const TypeDesc* type, TypeSyntaxPtr syntax) { registerTypeSyntax(*type, syntax); }

    void registerReservedWords(const StringSet& names);

    void registerInvalidTokens(const StringMap& tokens);

    const StringSet& getReservedWords() const { return _reservedWords; }

    const StringMap& getInvalidTokens() const { return _invalidTokens; }

    const TypeSyntax& getTypeSyntax(TypeDesc type) const;
    [[deprecated]] const TypeSyntax& getTypeSyntax(const TypeDesc* type) const { return getTypeSyntax(*type); }

    const vector<TypeSyntaxPtr>& getTypeSyntaxes() const { return _typeSyntaxes; }

    TypeDesc getType(const string& name) const { return _typeSystem->getType(name); }

    const string& getTypeName(TypeDesc type) const;
    [[deprecated]] const string& getTypeName(const TypeDesc* type) const { return getTypeName(*type); }

    virtual string getOutputTypeName(TypeDesc type) const;
    [[deprecated]] string getOutputTypeName(const TypeDesc* type) const { return getOutputTypeName(*type); }

    const string& getTypeAlias(TypeDesc type) const;
    [[deprecated]] const string& getTypeAlias(const TypeDesc* type) const { return getTypeAlias(*type); }

    const string& getTypeDefinition(TypeDesc type) const;
    [[deprecated]] const string& getTypeDefinition(const TypeDesc* type) const { return getTypeDefinition(*type); }

    const string& getDefaultValue(TypeDesc type, bool uniform = false) const;
    [[deprecated]] const string& getDefaultValue(const TypeDesc* type, bool uniform = false) const { return getDefaultValue(*type, uniform); }

    virtual string getValue(TypeDesc type, const Value& value, bool uniform = false) const;
    [[deprecated]] string getValue(const TypeDesc* type, const Value& value, bool uniform = false) const { return getValue(*type, value, uniform); }

    virtual string getValue(const ShaderPort* port, bool uniform = false) const;

    virtual const string& getInputQualifier() const { return EMPTY_STRING; };

    virtual const string& getOutputQualifier() const { return EMPTY_STRING; };

    virtual const string& getConstantQualifier() const = 0;

    virtual const string& getUniformQualifier() const { return EMPTY_STRING; };

    virtual const string& getNewline() const { return NEWLINE; };

    virtual const string& getIndentation() const { return INDENTATION; };

    virtual const string& getStringQuote() const { return STRING_QUOTE; };

    virtual const string& getIncludeStatement() const { return INCLUDE_STATEMENT; };

    virtual const string& getSingleLineComment() const { return SINGLE_LINE_COMMENT; };

    virtual const string& getBeginMultiLineComment() const { return BEGIN_MULTI_LINE_COMMENT; };

    virtual const string& getEndMultiLineComment() const { return END_MULTI_LINE_COMMENT; };

    virtual const string& getSourceFileExtension() const = 0;

    virtual string getArrayTypeSuffix(TypeDesc, const Value&) const { return EMPTY_STRING; };
    [[deprecated]] string getArrayTypeSuffix(const TypeDesc* type, const Value& value) const { return getArrayTypeSuffix(*type, value); }

    virtual string getArrayVariableSuffix(TypeDesc type, const Value& value) const;
    [[deprecated]] string getArrayVariableSuffix(const TypeDesc* type, const Value& value) const { return getArrayVariableSuffix(*type, value); }

    [[deprecated]] virtual bool typeSupported(const TypeDesc* type) const;

    virtual void makeValidName(string& name) const;

    virtual void makeIdentifier(string& name, IdentifierMap& identifiers) const;

    virtual string getVariableName(const string& name, TypeDesc type, IdentifierMap& identifiers) const;
    [[deprecated]] string getVariableName(const string& name, const TypeDesc* type, IdentifierMap& identifiers) const { return getVariableName(name, *type, identifiers); }

    virtual bool remapEnumeration(const string& value, TypeDesc type, const string& enumNames,
                                  std::pair<TypeDesc, ValuePtr>& result) const;
 
    // Create and return a type syntax for a struct type.
    virtual StructTypeSyntaxPtr createStructSyntax(const string& structTypeName, const string& defaultValue,
                                                   const string& uniformDefaultValue, const string& typeAlias,
                                                   const string& typeDefinition) const;

    static const string NEWLINE;
    static const string SEMICOLON;
    static const string COMMA;
 
  protected:
    Syntax(TypeSystemPtr typeSystem);
 
    TypeSystemPtr _typeSystem;
    vector<TypeSyntaxPtr> _typeSyntaxes;
    std::unordered_map<TypeDesc, size_t, TypeDesc::Hasher> _typeSyntaxIndexByType;
 
    StringSet _reservedWords;
    StringMap _invalidTokens;
 
    static const string INDENTATION;
    static const string STRING_QUOTE;
    static const string INCLUDE_STATEMENT;
    static const string SINGLE_LINE_COMMENT;
    static const string BEGIN_MULTI_LINE_COMMENT;
    static const string END_MULTI_LINE_COMMENT;
 
    static const std::unordered_map<char, size_t> CHANNELS_MAPPING;
};

class MX_GENSHADER_API TypeSyntax
{
  public:
    virtual ~TypeSyntax() { }

    const string& getName() const { return _name; }

    const string& getTypeAlias() const { return _typeAlias; }

    const string& getTypeDefinition() const { return _typeDefinition; }

    const string& getDefaultValue(bool uniform) const { return uniform ? _uniformDefaultValue : _defaultValue; }

    const StringVec& getMembers() const { return _members; }

    virtual string getValue(const ShaderPort* port, bool uniform) const;

    virtual string getValue(const Value& value, bool uniform) const = 0;
 
  protected:
    TypeSyntax(const Syntax* parent, const string& name, const string& defaultValue, const string& uniformDefaultValue,
               const string& typeAlias, const string& typeDefinition, const StringVec& members);
 
    const Syntax* _parent;       // parent syntax class
    string _name;                // type name
    string _defaultValue;        // default value syntax
    string _uniformDefaultValue; // default value syntax when assigned to uniforms
    string _typeAlias;           // type alias if needed in source code
    string _typeDefinition;      // custom type definition if needed in source code
    StringVec _members;          // syntax for member access
 
    static const StringVec EMPTY_MEMBERS;
};

class MX_GENSHADER_API ScalarTypeSyntax : public TypeSyntax
{
  public:
    ScalarTypeSyntax(const Syntax* parent, const string& name, const string& defaultValue, const string& uniformDefaultValue,
                     const string& typeAlias = EMPTY_STRING, const string& typeDefinition = EMPTY_STRING);
 
    string getValue(const Value& value, bool uniform) const override;
};

class MX_GENSHADER_API StringTypeSyntax : public ScalarTypeSyntax
{
  public:
    StringTypeSyntax(const Syntax* parent, const string& name, const string& defaultValue, const string& uniformDefaultValue,
                     const string& typeAlias = EMPTY_STRING, const string& typeDefinition = EMPTY_STRING);
 
    string getValue(const Value& value, bool uniform) const override;
};

class MX_GENSHADER_API AggregateTypeSyntax : public TypeSyntax
{
  public:
    AggregateTypeSyntax(const Syntax* parent, const string& name, const string& defaultValue, const string& uniformDefaultValue,
                        const string& typeAlias = EMPTY_STRING, const string& typeDefinition = EMPTY_STRING,
                        const StringVec& members = EMPTY_MEMBERS);
 
    string getValue(const Value& value, bool uniform) const override;
};

class MX_GENSHADER_API StructTypeSyntax : public TypeSyntax
{
  public:
    StructTypeSyntax(const Syntax* parent, const string& name, const string& defaultValue, const string& uniformDefaultValue,
                     const string& typeAlias = EMPTY_STRING, const string& typeDefinition = EMPTY_STRING,
                     const StringVec& members = EMPTY_MEMBERS);
 
    string getValue(const Value& value, bool uniform) const override;
};
 
MATERIALX_NAMESPACE_END
 
#endif