zeroc-ice 3.6.5 → 3.7.4

data/ext/ice/cpp/{include → src}/Slice/Parser.h

@@ -1,17 +1,13 @@
-// **********************************************************************
 //
-// Copyright (c) 2003-2018 ZeroC, Inc. All rights reserved.
+// Copyright (c) ZeroC, Inc. All rights reserved.
 //
-// This copy of Ice is licensed to you under the terms described in the
-// ICE_LICENSE file included in this distribution.
-//
-// **********************************************************************
 
 #ifndef SLICE_PARSER_H
 #define SLICE_PARSER_H
 
 #include <IceUtil/Shared.h>
 #include <IceUtil/Handle.h>
+#include <IceUtil/Exception.h>
 #include <string>
 #include <vector>
 #include <list>
@@ -20,36 +16,31 @@
 #include <set>
 #include <stdio.h>
 
-//
-// Automatically link Slice[D].lib with Visual C++
-//
+namespace Slice
+{
 
-#if !defined(ICE_BUILDING_SLICE) && defined(SLICE_API_EXPORTS)
-#   define ICE_BUILDING_SLICE
-#endif
+class CompilerException : public ::IceUtil::Exception
+{
+public:
 
-#if defined(_MSC_VER)
-#   if !defined(ICE_BUILDING_SLICE)
-#      if defined(_DEBUG) && !defined(ICE_OS_WINRT)
-#          pragma comment(lib, "SliceD.lib")
-#      else
-#          pragma comment(lib, "Slice.lib")
-#      endif
-#   endif
+    CompilerException(const char*, int, const std::string&);
+#ifndef ICE_CPP11_COMPILER
+    ~CompilerException() throw();
 #endif
-
-#ifndef SLICE_API
-#   ifdef SLICE_API_EXPORTS
-#       define SLICE_API ICE_DECLSPEC_EXPORT
-#   elif defined(ICE_STATIC_LIBS)
-#       define SLICE_API /**/
-#   else
-#       define SLICE_API ICE_DECLSPEC_IMPORT
-#   endif
+    virtual std::string ice_id() const;
+    virtual void ice_print(std::ostream&) const;
+#ifndef ICE_CPP11_MAPPING
+    virtual CompilerException* ice_clone() const;
 #endif
+    virtual void ice_throw() const;
 
-namespace Slice
-{
+    std::string reason() const;
+
+private:
+
+    static const char* _name;
+    const std::string _reason;
+};
 
 #if defined(_WIN32) && !defined(__MINGW32__)
 
@@ -77,12 +68,6 @@ const IceUtil::Int64 Int16Min = -Int16Max - 1;
 const IceUtil::Int64 ByteMax = 0xff;
 const IceUtil::Int64 ByteMin = 0x00;
 
-enum FeatureProfile
-{
-    Ice,
-    IceE
-};
-
 enum NodeType
 {
     Dummy,
@@ -99,6 +84,13 @@ enum FormatType
     SlicedFormat      // Full format.
 };
 
+enum WarningCategory
+{
+    All,
+    Deprecated,
+    InvalidMetaData
+};
+
 class GrammarBase;
 class SyntaxTreeBase;
 class Type;
@@ -189,7 +181,7 @@ struct OptionalDef
 // CICompare -- function object to do case-insensitive string comparison.
 // ----------------------------------------------------------------------
 
-class SLICE_API CICompare : public std::binary_function<std::string, std::string, bool>
+class CICompare : public std::binary_function<std::string, std::string, bool>
 {
 public:
 
@@ -197,7 +189,7 @@ public:
 };
 
 #if defined(__SUNPRO_CC)
-SLICE_API bool cICompare(const std::string&, const std::string&);
+bool cICompare(const std::string&, const std::string&);
 #endif
 
 // ----------------------------------------------------------------------
@@ -205,7 +197,7 @@ SLICE_API bool cICompare(const std::string&, const std::string&);
 // most-derived to least-derived order.
 // ----------------------------------------------------------------------
 
-class SLICE_API DerivedToBaseCompare : public std::binary_function<std::string, std::string, bool>
+class DerivedToBaseCompare : public std::binary_function<std::string, std::string, bool>
 {
 public:
 
@@ -213,14 +205,14 @@ public:
 };
 
 #if defined(__SUNPRO_CC)
-SLICE_API bool derivedToBaseCompare(const ExceptionPtr&, const ExceptionPtr&);
+bool derivedToBaseCompare(const ExceptionPtr&, const ExceptionPtr&);
 #endif
 
 // ----------------------------------------------------------------------
 // ParserVisitor
 // ----------------------------------------------------------------------
 
-class SLICE_API ParserVisitor
+class ParserVisitor
 {
 public:
 
@@ -249,7 +241,7 @@ public:
 // DefinitionContext
 // ----------------------------------------------------------------------
 
-class SLICE_API DefinitionContext : public ::IceUtil::SimpleShared
+class DefinitionContext : public ::IceUtil::SimpleShared
 {
 public:
 
@@ -267,20 +259,70 @@ public:
     std::string findMetaData(const std::string&) const;
     StringList getMetaData() const;
 
+    //
+    // Emit warning unless filtered out by [["suppress-warning"]]
+    //
+    void warning(WarningCategory, const std::string&, int, const std::string&) const;
+    void warning(WarningCategory, const std::string&, const std::string&, const std::string&) const;
+
+    void error(const std::string&, int, const std::string&) const;
+    void error(const std::string&, const std::string&, const std::string&) const;
+
 private:
 
+    bool suppressWarning(WarningCategory) const;
+    void initSuppressedWarnings();
+
     int _includeLevel;
     StringList _metaData;
     std::string _filename;
     bool _seenDefinition;
+    std::set<WarningCategory> _suppressedWarnings;
 };
 typedef ::IceUtil::Handle<DefinitionContext> DefinitionContextPtr;
 
+// ----------------------------------------------------------------------
+// Comment
+// ----------------------------------------------------------------------
+
+class Comment : public ::IceUtil::SimpleShared
+{
+public:
+
+    bool isDeprecated() const;
+    StringList deprecated() const;
+
+    StringList overview() const;  // Contains all introductory lines up to the first tag.
+    StringList misc() const;      // Contains unrecognized tags.
+    StringList seeAlso() const;   // Targets of @see tags.
+
+    StringList returns() const;                           // Description of an operation's return value.
+    std::map<std::string, StringList> parameters() const; // Parameter descriptions for an op. Key is parameter name.
+    std::map<std::string, StringList> exceptions() const; // Exception descriptions for an op. Key is exception name.
+
+private:
+
+    Comment();
+
+    bool _isDeprecated;
+    StringList _deprecated;
+    StringList _overview;
+    StringList _misc;
+    StringList _seeAlso;
+
+    StringList _returns;
+    std::map<std::string, StringList> _parameters;
+    std::map<std::string, StringList> _exceptions;
+
+    friend class Contained;
+};
+typedef ::IceUtil::Handle<Comment> CommentPtr;
+
 // ----------------------------------------------------------------------
 // GrammarBase
 // ----------------------------------------------------------------------
 
-class SLICE_API GrammarBase : public ::IceUtil::SimpleShared
+class GrammarBase : public ::IceUtil::SimpleShared
 {
 };
 
@@ -288,7 +330,7 @@ class SLICE_API GrammarBase : public ::IceUtil::SimpleShared
 // SyntaxTreeBase
 // ----------------------------------------------------------------------
 
-class SLICE_API SyntaxTreeBase : public GrammarBase
+class SyntaxTreeBase : public GrammarBase
 {
 public:
 
@@ -299,7 +341,7 @@ public:
 
 protected:
 
-    SyntaxTreeBase(const UnitPtr&);
+    SyntaxTreeBase(const UnitPtr&, const DefinitionContextPtr& = 0);
 
     UnitPtr _unit;
     DefinitionContextPtr _definitionContext;
@@ -309,7 +351,7 @@ protected:
 // Type
 // ----------------------------------------------------------------------
 
-class SLICE_API Type : virtual public SyntaxTreeBase
+class Type : public virtual SyntaxTreeBase
 {
 public:
 
@@ -328,7 +370,7 @@ protected:
 // Builtin
 // ----------------------------------------------------------------------
 
-class SLICE_API Builtin : virtual public Type
+class Builtin : public virtual Type
 {
 public:
 
@@ -344,7 +386,8 @@ public:
         KindString,
         KindObject,
         KindObjectProxy,
-        KindLocalObject
+        KindLocalObject,
+        KindValue
     };
 
     virtual bool isLocal() const;
@@ -370,7 +413,7 @@ protected:
 // Contained
 // ----------------------------------------------------------------------
 
-class SLICE_API Contained : virtual public SyntaxTreeBase
+class Contained : public virtual SyntaxTreeBase
 {
 public:
 
@@ -382,6 +425,7 @@ public:
     std::string file() const;
     std::string line() const;
     std::string comment() const;
+    CommentPtr parseComment(bool) const;
 
     int includeLevel() const;
     void updateIncludeLevel();
@@ -416,7 +460,6 @@ public:
 
     bool operator<(const Contained&) const;
     bool operator==(const Contained&) const;
-    bool operator!=(const Contained&) const;
 
 protected:
 
@@ -437,14 +480,14 @@ protected:
 // Container
 // ----------------------------------------------------------------------
 
-class SLICE_API Container : virtual public SyntaxTreeBase
+class Container : public virtual SyntaxTreeBase
 {
 public:
 
     virtual void destroy();
     ModulePtr createModule(const std::string&);
     ClassDefPtr createClassDef(const std::string&, int, bool, const ClassList&, bool);
-    ClassDeclPtr createClassDecl(const std::string&, bool, bool, bool = true);
+    ClassDeclPtr createClassDecl(const std::string&, bool, bool);
     ExceptionPtr createException(const std::string&, const ExceptionPtr&, bool, NodeType = Real);
     StructPtr createStruct(const std::string&, bool, NodeType = Real);
     SequencePtr createSequence(const std::string&, const TypePtr&, const StringList&, bool, NodeType = Real);
@@ -456,7 +499,7 @@ public:
     ConstPtr createConst(const std::string, const TypePtr&, const StringList&, const SyntaxTreeBasePtr&,
                          const std::string&, const std::string&, NodeType = Real);
     TypeList lookupType(const std::string&, bool = true);
-    TypeList lookupTypeNoBuiltin(const std::string&, bool = true);
+    TypeList lookupTypeNoBuiltin(const std::string&, bool = true, bool = false);
     ContainedList lookupContained(const std::string&, bool = true);
     ExceptionPtr lookupException(const std::string&, bool = true);
     UnitPtr unit() const;
@@ -467,6 +510,8 @@ public:
     SequenceList sequences() const;
     DictionaryList dictionaries() const;
     EnumList enums() const;
+    EnumeratorList enumerators() const;
+    EnumeratorList enumerators(const std::string&) const;
     ConstList consts() const;
     ContainedList contents() const;
     bool hasNonLocalClassDecls() const;
@@ -474,12 +519,18 @@ public:
     bool hasLocalClassDefsWithAsync() const;
     bool hasNonLocalSequences() const;
     bool hasNonLocalExceptions() const;
+    bool hasStructs() const;
+    bool hasExceptions() const;
     bool hasDictionaries() const;
     bool hasOnlyDictionaries(DictionaryList&) const;
     bool hasClassDecls() const;
     bool hasClassDefs() const;
+    bool hasLocalClassDefs() const;
+    bool hasNonLocalInterfaceDefs() const;
+    bool hasValueDefs() const;
     bool hasOnlyClassDecls() const;
-    bool hasAbstractClassDefs() const;
+    bool hasOperations() const; // interfaces or classes with operations
+    bool hasNonLocalAbstractClassDefs() const; // interfaces or abstract classes
     bool hasNonLocalDataOnlyClasses() const;
     bool hasOtherConstructedOrExceptions() const; // Exceptions or constructed types other than classes.
     bool hasContentsWithMetaData(const std::string&) const;
@@ -500,10 +551,9 @@ protected:
 
     Container(const UnitPtr&);
 
-    void checkIdentifier(const std::string&) const;
     bool checkInterfaceAndLocal(const std::string&, bool, bool, bool, bool, bool);
     bool checkGlobalMetaData(const StringList&, const StringList&);
-    bool validateConstant(const std::string&, const TypePtr&, const SyntaxTreeBasePtr&, const std::string&, bool);
+    bool validateConstant(const std::string&, const TypePtr&, SyntaxTreeBasePtr&, const std::string&, bool);
     EnumeratorPtr validateEnumerator(const std::string&);
 
     ContainedList _contents;
@@ -514,7 +564,7 @@ protected:
 // Module
 // ----------------------------------------------------------------------
 
-class SLICE_API Module : virtual public Container, virtual public Contained
+class Module : public virtual Container, public virtual Contained
 {
 public:
 
@@ -533,7 +583,7 @@ protected:
 // Constructed
 // ----------------------------------------------------------------------
 
-class SLICE_API Constructed : virtual public Type, virtual public Contained
+class Constructed : public virtual Type, public virtual Contained
 {
 public:
 
@@ -554,7 +604,7 @@ protected:
 // ClassDecl
 // ----------------------------------------------------------------------
 
-class SLICE_API ClassDecl : virtual public Constructed
+class ClassDecl : public virtual Constructed
 {
 public:
 
@@ -596,7 +646,7 @@ private:
 // Operation
 // ----------------------------------------------------------------------
 
-class SLICE_API Operation : virtual public Contained, virtual public Container
+class Operation : public virtual Contained, public virtual Container
 {
 public:
 
@@ -616,8 +666,13 @@ public:
     int returnTag() const;
     Mode mode() const;
     Mode sendMode() const;
+    bool hasMarshaledResult() const;
     ParamDeclPtr createParamDecl(const std::string&, const TypePtr&, bool, bool, int);
     ParamDeclList parameters() const;
+    ParamDeclList inParameters() const;
+    void inParameters(ParamDeclList&, ParamDeclList&) const;
+    ParamDeclList outParameters() const;
+    void outParameters(ParamDeclList&, ParamDeclList&) const;
     ExceptionList throws() const;
     void setExceptionList(const ExceptionList&);
     virtual ContainedType containedType() const;
@@ -625,6 +680,7 @@ public:
     bool sendsClasses(bool) const;
     bool returnsClasses(bool) const;
     bool returnsData() const;
+    bool returnsMultipleValues() const;
     bool sendsOptionals() const;
     int attributes() const;
     FormatType format() const;
@@ -654,7 +710,7 @@ protected:
 // so if you need the class as a "constructed type", use the
 // declaration() operation to navigate to the class declaration.
 //
-class SLICE_API ClassDef : virtual public Container, virtual public Contained
+class ClassDef : public virtual Container, public virtual Contained
 {
 public:
 
@@ -681,11 +737,13 @@ public:
     bool hasOperations() const;
     bool hasDefaultValues() const;
     bool inheritsMetaData(const std::string&) const;
+    bool hasBaseDataMembers() const;
     virtual ContainedType containedType() const;
     virtual bool uses(const ContainedPtr&) const;
     virtual std::string kindOf() const;
     virtual void visit(ParserVisitor*, bool);
     int compactId() const;
+    bool isDelegate() const;
 
 protected:
 
@@ -705,7 +763,7 @@ protected:
 // Proxy
 // ----------------------------------------------------------------------
 
-class SLICE_API Proxy : virtual public Type
+class Proxy : public virtual Type
 {
 public:
 
@@ -721,7 +779,7 @@ public:
 
 protected:
 
-    ClassDeclPtr __class;
+    ClassDeclPtr _classDecl;
 };
 
 // ----------------------------------------------------------------------
@@ -729,7 +787,7 @@ protected:
 // ----------------------------------------------------------------------
 
 // No inheritance from Constructed, as this is not a Type
-class SLICE_API Exception : virtual public Container, virtual public Contained
+class Exception : public virtual Container, public virtual Contained
 {
 public:
 
@@ -750,6 +808,7 @@ public:
     bool usesClasses(bool) const;
     bool hasDefaultValues() const;
     bool inheritsMetaData(const std::string&) const;
+    bool hasBaseDataMembers() const;
     virtual std::string kindOf() const;
     virtual void visit(ParserVisitor*, bool);
 
@@ -766,7 +825,7 @@ protected:
 // Struct
 // ----------------------------------------------------------------------
 
-class SLICE_API Struct : virtual public Container, virtual public Constructed
+class Struct : public virtual Container, public virtual Constructed
 {
 public:
 
@@ -794,7 +853,7 @@ protected:
 // Sequence
 // ----------------------------------------------------------------------
 
-class SLICE_API Sequence : virtual public Constructed
+class Sequence : public virtual Constructed
 {
 public:
 
@@ -822,7 +881,7 @@ protected:
 // Dictionary
 // ----------------------------------------------------------------------
 
-class SLICE_API Dictionary : virtual public Constructed
+class Dictionary : public virtual Constructed
 {
 public:
 
@@ -857,13 +916,11 @@ protected:
 // Enum
 // ----------------------------------------------------------------------
 
-class SLICE_API Enum : virtual public Constructed
+class Enum : public virtual Container, public virtual Constructed
 {
 public:
 
     virtual void destroy();
-    EnumeratorList getEnumerators();
-    void setEnumerators(const EnumeratorList&);
     bool explicitValue() const;
     int minValue() const;
     int maxValue() const;
@@ -879,19 +936,22 @@ public:
 protected:
 
     Enum(const ContainerPtr&, const std::string&, bool);
+    int newEnumerator(const EnumeratorPtr&);
+
     friend class Container;
+    friend class Enumerator;
 
-    EnumeratorList _enumerators;
     bool _explicitValue;
     IceUtil::Int64 _minValue;
     IceUtil::Int64 _maxValue;
+    int _lastValue;
 };
 
 // ----------------------------------------------------------------------
 // Enumerator
 // ----------------------------------------------------------------------
 
-class SLICE_API Enumerator : virtual public Contained
+class Enumerator : public virtual Contained
 {
 public:
 
@@ -908,9 +968,7 @@ protected:
     Enumerator(const ContainerPtr&, const std::string&);
     Enumerator(const ContainerPtr&, const std::string&, int);
     friend class Container;
-    friend class Enum;
 
-    EnumPtr _type;
     bool _explicitValue;
     int _value;
 };
@@ -919,7 +977,7 @@ protected:
 // Const
 // ----------------------------------------------------------------------
 
-class SLICE_API Const : virtual public Contained
+class Const : public virtual Contained
 {
 public:
 
@@ -950,7 +1008,7 @@ protected:
 // ParamDecl
 // ----------------------------------------------------------------------
 
-class SLICE_API ParamDecl : virtual public Contained
+class ParamDecl : public virtual Contained
 {
 public:
 
@@ -978,7 +1036,7 @@ protected:
 // DataMember
 // ----------------------------------------------------------------------
 
-class SLICE_API DataMember : virtual public Contained
+class DataMember : public virtual Contained
 {
 public:
 
@@ -993,7 +1051,6 @@ public:
     virtual std::string kindOf() const;
     virtual void visit(ParserVisitor*, bool);
 
-
 protected:
 
     DataMember(const ContainerPtr&, const std::string&, const TypePtr&, bool, int, const SyntaxTreeBasePtr&,
@@ -1014,7 +1071,7 @@ protected:
 // Unit
 // ----------------------------------------------------------------------
 
-class SLICE_API Unit : virtual public Container
+class Unit : public virtual Container
 {
 public:
 
@@ -1038,11 +1095,8 @@ public:
 
     void setSeenDefinition();
 
-    void error(const char*); // Not const, because error count is increased.
-    void error(const std::string&); // Ditto.
-
-    void warning(const char*) const;
-    void warning(const std::string&) const;
+    void error(const std::string&); // Not const because error count is increased
+    void warning(WarningCategory, const std::string&) const;
 
     ContainerPtr currentContainer() const;
     void pushContainer(const ContainerPtr&);
@@ -1061,13 +1115,12 @@ public:
     ContainedList findUsedBy(const ContainedPtr&) const;
 
     void addTypeId(int, const std::string&);
-    std::string getTypeId(int);
+    std::string getTypeId(int) const;
+    bool hasCompactTypeId() const;
 
     bool usesNonLocals() const;
     bool usesConsts() const;
 
-    FeatureProfile profile() const;
-
     //
     // Returns the path names of the files included directly by the top-level file.
     //
@@ -1078,7 +1131,7 @@ public:
     //
     StringList allFiles() const;
 
-    int parse(const std::string&, FILE*, bool, FeatureProfile profile = Ice);
+    int parse(const std::string&, FILE*, bool);
 
     virtual void destroy();
     virtual void visit(ParserVisitor*, bool);
@@ -1109,13 +1162,12 @@ private:
     std::stack<ContainerPtr> _containerStack;
     std::map<Builtin::Kind, BuiltinPtr> _builtins;
     std::map<std::string, ContainedList> _contentMap;
-    FeatureProfile _featureProfile;
     std::map<std::string, DefinitionContextPtr> _definitionContextMap;
     std::map<int, std::string> _typeIds;
     std::map< std::string, std::set<std::string> > _fileTopLevelModules;
 };
 
-extern SLICE_API Unit* unit; // The current parser for bison/flex
+extern Unit* unit; // The current parser for bison/flex
 
 }