TAO/TAO_IDL/include/idl_version.h

   1 /**
   2  * Header File for Tracking IDL Versions
   3  *
   4  * Source File Counterpart is util/idl_version.cpp.
   5  */
   6
   7 #ifndef IDL_VERSION_HEADER
   8 #define IDL_VERSION_HEADER
   9
  10 #include "TAO_IDL_FE_Export.h"
  11
  12 /**
  13  * List of Specific Idl Versions
  14  *
  15  * Order is used to determine how versions compare to each other.
  16  *
  17  * NOTE: If updated, idlVersionNames in util/idl_version.cpp must be updated
  18  * as well!
  19  */
  20 enum SpecificIdlVersion
  21 {
  22   /// Invalid Version Value
  23   IDL_VERSION_INVALID,
  24
  25   /**
  26    * IDL 3.x
  27    * tao_idl dialect of IDL defined in OMG CORBA and IDL 3.5 specs.
  28    * This is the version of IDL supported by the compiler as is without IDL
  29    * version checks.
  30    */
  31   IDL_VERSION_3,
  32
  33   /**
  34    * IDL 4.x
  35    * tao_idl dialect of IDL as defined in OMG 2016-04-02 (http://www.omg.org/spec/IDL/4.0/)
  36    * and later revisions.
  37    */
  38   IDL_VERSION_4,
  39
  40   /**
  41    * SHOULD ALWAYS BE LAST, DO NOT PUT ANY VERSIONS PAST THIS!
  42    *
  43    * Attempting to pass this to IdlVersion will result in an invalid value.
  44    */
  45   IDL_VERSION_COUNT
  46 };
  47
  48 /**
  49  * Default version of IDL to use if BE does not specify a default version.
  50  * This is so that BE can control the version without overriding idl_version_
  51  * directly and making --default-idl-version incorrect.
  52  */
  53 const SpecificIdlVersion DEFAULT_DEFAULT_IDL_VERSION = IDL_VERSION_3;
  54
  55 /**
  56  * Class Operations involving SpecificIdlVersion Values
  57  */
  58 class TAO_IDL_FE_Export IdlVersion
  59 {
  60 public:
  61   /**
  62    * New IdlVersion set to DEFAULT_DEFAULT_IDL_VERSION.
  63    */
  64   IdlVersion ();
  65
  66   /**
  67    * New IdlVersion set from a SpecificIdlVersion if version is valid,
  68    * otherwise IDL_VERSION_INVALID.
  69    */
  70   IdlVersion (SpecificIdlVersion version);
  71
  72   /**
  73    * Get version as a SpecificIdlVersion.
  74    */
  75   SpecificIdlVersion version () const;
  76   /**
  77    * Set version from a SpecificIdlVersion if version is valid, otherwise
  78    * IDL_VERSION_INVALID.
  79    */
  80   void version (SpecificIdlVersion version);
  81
  82   /**
  83    * Is Version Valid?
  84    */
  85   bool is_valid () const;
  86
  87   /**
  88    * Get version as string.
  89    */
  90   const char * to_string () const;
  91   /**
  92    * Set version from string, sets versions as invalid if it does not match
  93    * any strings in idlVersionNames.
  94    */
  95   void from_string (const char * version);
  96
  97   /**
  98    * Get the value for the __TAO_IDL_IDL_VERSION preprocessor macro.
  99    */
 100   const char * to_macro () const;
 101
 102   /**
 103    * Compare a IdlVersion to a SpecificIdlVersion or another IdlVersion
 104    */
 105   ///{
 106   operator SpecificIdlVersion () const;
 107   bool operator== (SpecificIdlVersion other) const;
 108   bool operator!= (SpecificIdlVersion other) const;
 109   bool operator> (SpecificIdlVersion other) const;
 110   bool operator>= (SpecificIdlVersion other) const;
 111   bool operator< (SpecificIdlVersion other) const;
 112   bool operator<= (SpecificIdlVersion other) const;
 113   ///}
 114
 115 private:
 116   SpecificIdlVersion version_;
 117 };
 118
 119 #endif