cppconst.h

Go to the documentation of this file.

/*
   The MIT License (MIT)
 
   Copyright (c) 2018 Satya Das
 
   Permission is hereby granted, free of charge, to any person obtaining a copy of
   this software and associated documentation files (the "Software"), to deal in
   the Software without restriction, including without limitation the rights to
   use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
   the Software, and to permit persons to whom the Software is furnished to do so,
   subject to the following conditions:
 
   The above copyright notice and this permission notice shall be included in all
   copies or substantial portions of the Software.
 
   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
   FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
   COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
   IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
   CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
 
#pragma once
 
#include <cstdint>
 
enum class TriStateBool : std::int8_t
{
  Unknown = -1,
  False   = 0,
  True    = 1
};
 
enum class CppObjType : std::uint8_t
{
  kUnknown = 0x0000,
  kDocComment,
 
  kCPreProcessorTypeStarts, // Any preprocessor type must come after this
  kHashIf,                  // #if, #ifdef, #ifndef, #else, #elif.
  kHashInclude,             // #include
  kHashImport,              // #import
  kHashDefine,              // #define
  kHashUndef,               // #undef
  kHashPragma,              // #pragma
  kHashError,
  kHashWarning,
  kUnRecogPrePro, // Any unrecognized pre-processor.
  kCPreProcessorTypeEnds,
 
  kCppStatementObjectTypeStarts,
  kVarType, // Just the type of variable.
  kVar,     // A variable declaration.
  kVarList, // List of variables declared as comma separated identifiers.
  kTypedefName,
  kTypedefNameList,
  kNamespaceAlias,
  kUsingNamespaceDecl,
  kUsingDecl,
  kEnum,
  kCompound,   // file, namespace, class, struct, union, block.
  kFwdClsDecl, // Forward declaration of compound type.
  kFunction,
  kLambda,
  kConstructor,
  kDestructor,
  kTypeConverter,
  kFunctionPtr, // Function proc declaration using typedef. e.g. typedef void (*fp) (void);
  kExpression,  // A C++ expression
  kExpressionList,
  kMacroCall,
  kAsmBlock,
  kBlob, // Some unparsed/unrecognized part of C++ source code.
  kLabel,
  kCppStatementObjectTypeEnds,
 
  kCppControlStatementStarts,
  kIfBlock,
  kForBlock,
  kRangeForBlock,
  kWhileBlock,
  kDoWhileBlock,
  kSwitchBlock,
  kTryBlock,
  kCppControlStatementEnds,
};
 
enum /*class*/ CppCompoundType : std::uint8_t
{
  kUnknownCompound = 0x00,
  kNoCompound      = 0x00,
  kCppFile         = 0x01,
  kNamespace       = 0x02,
  kClass           = 0x04 | kNamespace,
  kStruct          = 0x08 | kClass,
  kUnion           = 0x10 | kClass,
  kBlock           = 0x20,
  kExternCBlock    = 0x40,
};
 
enum class CppAccessType : std::uint8_t
{
  kUnknown,
  kPublic,
  kPrivate,
  kProtected
};
 
enum /*class*/ CppOperator : std::uint8_t
{
  kNone,
 
  kUnariPrefixOperatorStart,
  kUnaryMinus,   // -
  kBitToggle,    // ~
  kLogNot,       // ! (Logical not)
  kDerefer,      // *
  kRefer,        // & as in &x;
  kPreIncrement, // ++i
  kPreDecrement, // --i
 
  kUnariSufixOperatorStart,
  kPostIncrement, // i++
  kPostDecrement, // i--
 
  kBinaryOperatorStart,
  kPlus,  // +
  kMinus, // -
  kMul,   // *
  kDiv,   // /
  kPercent,
  kAnd,
  kOr,
  kBitAnd, // &
  kBitOr,  // |
  kXor,
  kEqual,   // =
  kLess,    // <
  kGreater, // >
  kPlusEqual,
  kMinusEqual,
  kMulEqual,
  kDivEqual,
  kPerEqual,
  kXorEqual,
  kAndEqual,
  kOrEqual,
  kLeftShift, // <<
  kInsertion = kLeftShift,
  kRightShift, // >>
  kExtraction = kRightShift,
  kLShiftEqual, // <<=
  kRShiftEqual, // >>=
  kCmpEqual,    // ==
  kNotEqual,    // ==
  kLessEqual,   // <=
  kGreaterEqual,
  k3WayCmp,
  kComma,
  kBinaryOperatorEnd,
 
  kDerefOperatorStart,
  kDot,   // .
  kArrow, // ->
  kArrowStar,
 
  kSpecialOperations = 100,
  kFunctionCall,
  kUniformInitCall,
  kArrayElem, // x[5]
  kCStyleCast,
  kFunctionStyleCast,
  kConstCast,
  kStaticCast,
  kDynamicCast,
  kReinterpretCast,
  kPlacementNew,
 
  kTertiaryOperator,
};
 
enum /*class*/ CppIdentifierAttrib : std::uint32_t
{
  kFuncParam     = 0x000001, // If the identifier is actually function parameter.
  kConst         = 0x000002,
  kStatic        = 0x000004,
  kExtern        = 0x000008,
  kInline        = 0x000010,
  kVirtual       = 0x000020,
  kPureVirtual   = 0x000040 | kVirtual,
  kOverride      = 0x000080 | kVirtual,
  kExplicit      = 0x000100,
  kFriend        = 0x000200,
  kTypedef       = 0x000400, // Function pointer is used in typedef.
  kConstExpr     = 0x001000,
  kVolatile      = 0x002000,
  kFinal         = 0x004000 | kVirtual,
  kDefault       = 0x008000,
  kDelete        = 0x010000,
  kNoExcept      = 0x020000,
  kExternC       = 0x040000,
  kTrailingRet   = 0x080000,
  kMutable       = 0x100000,
  kNoExceptFalse = 0x200000,
};
 
enum class CppRefType : std::uint8_t
{
  kNoRef,  // No reference.
  kByRef,  // Simple reference, e.g. int& x.
  kRValRef // R-value reference, e.g. in move constructor.
};
 
enum class AssignType
{
  kNone,
  kUsingEqual,
  kUsingBracket,
  kUsingBraces
};