APEX_Names.h

Go to the documentation of this file.

/*
* PROPRIETARY INFORMATION.  This software is proprietary to
* Side Effects Software Inc., and is not to be reproduced,
* transmitted, or disclosed in any way without written permission.
*
* NAME:        APEX_Names.h (APEX Library, C++)
*
* COMMENTS:    Cached UT_StringLit strings for common apex names,
*              so that the hash and length only get computed once,
*              and equality can be checked using the pointers first.
*/

#pragma once

#ifndef __APEX_NAMES_H__
#define __APEX_NAMES_H__

#include <UT/UT_StringHolder.h>

namespace APEX_Names
{

inline constexpr UT_StringLit theGraphParmsName     = "__parms__";
inline constexpr UT_StringLit theBindingName        = "__binding__"; // deprecated, replaced by theOutputName
inline constexpr UT_StringLit theOutputName         = "__output__";
inline constexpr UT_StringLit theSubnetName         = "__subnet__";
inline constexpr UT_StringLit theNullName           = "__null__";
inline constexpr UT_StringLit theStickyNoteName     = "__stickynote__";
inline constexpr UT_StringLit theSubGraphGeoPath    = "<subgraph>";
inline constexpr UT_StringLit theGraphExt           = ".graph";

// APEX Graph Geometry Attributes
inline constexpr UT_StringLit theCallbackAttribName     = "callback";
inline constexpr UT_StringLit theCdAttribName           = "Cd";
inline constexpr UT_StringLit theCommentAttribName      = "comment";
inline constexpr UT_StringLit theNameAttribName         = "name";
inline constexpr UT_StringLit theOutputAttribName       = "output";
inline constexpr UT_StringLit theParmsAttribName        = "parms";
inline constexpr UT_StringLit thePropertiesAttribName   = "properties";
inline constexpr UT_StringLit thePortAliasAttribName    = "portalias";
inline constexpr UT_StringLit thePortIndexAttribName    = "portindex";
inline constexpr UT_StringLit thePortNameAttribName     = "portname";
inline constexpr UT_StringLit theTagsAttribName         = "tags";
inline constexpr UT_StringLit theTypeHintAttribName     = "typehint";

// Optional Debugging APEX Graph Geometry Attributes
inline constexpr UT_StringLit theDebugMemAttribName        = "__mem__";
inline constexpr UT_StringLit theDebugPortsAttribName      = "__ports__";
inline constexpr UT_StringLit theDebugScopeIDAttribName    = "__scopeid__";
inline constexpr UT_StringLit theDebugGraphParmsAttribName = "__debugparms__";

} // namespace APEX_Names

#endif // __APEX_NAMES_H__