zeroc-ice 3.7.0 → 3.7.1

data/ext/ice/cpp/include/generated/Ice/ProcessF.h

@@ -1,13 +1,13 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// Copyright (c) 2003-2018 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.
 //
 // **********************************************************************
 //
-// Ice version 3.7.0
+// Ice version 3.7.1
 //
 // <auto-generated>
 //
@@ -41,7 +41,7 @@
 #   if ICE_INT_VERSION % 100 > 50
 #       error Beta header file detected
 #   endif
-#   if ICE_INT_VERSION % 100 < 0
+#   if ICE_INT_VERSION % 100 < 1
 #       error Ice patch level mismatch!
 #   endif
 #endif
@@ -66,11 +66,14 @@ class ProcessPrx;
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
+/// \cond INTERNAL
 namespace Ice
 {
 
@@ -78,6 +81,7 @@ using ProcessPtr = ::std::shared_ptr<Process>;
 using ProcessPrxPtr = ::std::shared_ptr<ProcessPrx>;
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
@@ -88,8 +92,10 @@ namespace Ice
 {
 
 class Process;
+/// \cond INTERNAL
 ICE_API void _readProxy(::Ice::InputStream*, ::IceInternal::ProxyHandle< ::IceProxy::Ice::Process>&);
 ICE_API ::IceProxy::Ice::Object* upCast(::IceProxy::Ice::Process*);
+/// \endcond
 
 }
 
@@ -99,18 +105,24 @@ namespace Ice
 {
 
 class Process;
-ICE_API ::Ice::Object* upCast(::Ice::Process*);
-typedef ::IceInternal::Handle< ::Ice::Process> ProcessPtr;
+/// \cond INTERNAL
+ICE_API Object* upCast(Process*);
+/// \endcond
+typedef ::IceInternal::Handle< Process> ProcessPtr;
 typedef ::IceInternal::ProxyHandle< ::IceProxy::Ice::Process> ProcessPrx;
 typedef ProcessPrx ProcessPrxPtr;
-ICE_API void _icePatchObjectPtr(ProcessPtr&, const ::Ice::ObjectPtr&);
+/// \cond INTERNAL
+ICE_API void _icePatchObjectPtr(ProcessPtr&, const ObjectPtr&);
+/// \endcond
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
 #endif
 

data/ext/ice/cpp/include/generated/Ice/Properties.h

@@ -1,13 +1,13 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// Copyright (c) 2003-2018 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.
 //
 // **********************************************************************
 //
-// Ice version 3.7.0
+// Ice version 3.7.1
 //
 // <auto-generated>
 //
@@ -47,7 +47,7 @@
 #   if ICE_INT_VERSION % 100 > 50
 #       error Beta header file detected
 #   endif
-#   if ICE_INT_VERSION % 100 < 0
+#   if ICE_INT_VERSION % 100 < 1
 #       error Ice patch level mismatch!
 #   endif
 #endif
@@ -74,52 +74,175 @@ class Properties;
 namespace Ice
 {
 
+/**
+ * A property set used to configure Ice and Ice applications.
+ * Properties are key/value pairs, with both keys and values
+ * being strings. By convention, property keys should have the form
+ * <em>application-name</em>\[.<em>category</em>\[.<em>sub-category</em>]].<em>name</em>.
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) Properties
 {
 public:
 
     ICE_MEMBER(ICE_API) virtual ~Properties();
 
-    virtual ::std::string getProperty(const ::std::string&) = 0;
-
-    virtual ::std::string getPropertyWithDefault(const ::std::string&, const ::std::string&) = 0;
-
-    virtual int getPropertyAsInt(const ::std::string&) = 0;
-
-    virtual int getPropertyAsIntWithDefault(const ::std::string&, int) = 0;
-
-    virtual ::Ice::StringSeq getPropertyAsList(const ::std::string&) = 0;
-
-    virtual ::Ice::StringSeq getPropertyAsListWithDefault(const ::std::string&, const ::Ice::StringSeq&) = 0;
-
-    virtual ::Ice::PropertyDict getPropertiesForPrefix(const ::std::string&) = 0;
-
-    virtual void setProperty(const ::std::string&, const ::std::string&) = 0;
-
-    virtual ::Ice::StringSeq getCommandLineOptions() = 0;
-
-    virtual ::Ice::StringSeq parseCommandLineOptions(const ::std::string&, const ::Ice::StringSeq&) = 0;
-
-    virtual ::Ice::StringSeq parseIceCommandLineOptions(const ::Ice::StringSeq&) = 0;
-
-    virtual void load(const ::std::string&) = 0;
-
-    virtual ::std::shared_ptr<::Ice::Properties> clone() = 0;
+    /**
+     * Get a property by key. If the property is not set, an empty
+     * string is returned.
+     * @param key The property key.
+     * @return The property value.
+     * @see #setProperty
+     */
+    virtual ::std::string getProperty(const ::std::string& key) noexcept = 0;
+
+    /**
+     * Get a property by key. If the property is not set, the
+     * given default value is returned.
+     * @param key The property key.
+     * @param value The default value to use if the property does not
+     * exist.
+     * @return The property value or the default value.
+     * @see #setProperty
+     */
+    virtual ::std::string getPropertyWithDefault(const ::std::string& key, const ::std::string& value) noexcept = 0;
+
+    /**
+     * Get a property as an integer. If the property is not set, 0
+     * is returned.
+     * @param key The property key.
+     * @return The property value interpreted as an integer.
+     * @see #setProperty
+     */
+    virtual int getPropertyAsInt(const ::std::string& key) noexcept = 0;
+
+    /**
+     * Get a property as an integer. If the property is not set, the
+     * given default value is returned.
+     * @param key The property key.
+     * @param value The default value to use if the property does not
+     * exist.
+     * @return The property value interpreted as an integer, or the
+     * default value.
+     * @see #setProperty
+     */
+    virtual int getPropertyAsIntWithDefault(const ::std::string& key, int value) noexcept = 0;
+
+    /**
+     * Get a property as a list of strings. The strings must be
+     * separated by whitespace or comma. If the property is not set,
+     * an empty list is returned. The strings in the list can contain
+     * whitespace and commas if they are enclosed in single or double
+     * quotes. If quotes are mismatched, an empty list is returned.
+     * Within single quotes or double quotes, you can escape the
+     * quote in question with \, e.g. O'Reilly can be written as
+     * O'Reilly, "O'Reilly" or 'O\'Reilly'.
+     * @param key The property key.
+     * @return The property value interpreted as a list of strings.
+     * @see #setProperty
+     */
+    virtual ::Ice::StringSeq getPropertyAsList(const ::std::string& key) noexcept = 0;
+
+    /**
+     * Get a property as a list of strings.  The strings must be
+     * separated by whitespace or comma. If the property is not set,
+     * the default list is returned. The strings in the list can contain
+     * whitespace and commas if they are enclosed in single or double
+     * quotes. If quotes are mismatched, the default list is returned.
+     * Within single quotes or double quotes, you can escape the
+     * quote in question with \, e.g. O'Reilly can be written as
+     * O'Reilly, "O'Reilly" or 'O\'Reilly'.
+     * @param key The property key.
+     * @param value The default value to use if the property is not set.
+     * @return The property value interpreted as list of strings, or the
+     * default value.
+     * @see #setProperty
+     */
+    virtual ::Ice::StringSeq getPropertyAsListWithDefault(const ::std::string& key, const StringSeq& value) noexcept = 0;
+
+    /**
+     * Get all properties whose keys begins with
+     * <em>prefix</em>. If
+     * <em>prefix</em> is an empty string,
+     * then all properties are returned.
+     * @param prefix The prefix to search for (empty string if none).
+     * @return The matching property set.
+     */
+    virtual ::Ice::PropertyDict getPropertiesForPrefix(const ::std::string& prefix) noexcept = 0;
+
+    /**
+     * Set a property. To unset a property, set it to
+     * the empty string.
+     * @param key The property key.
+     * @param value The property value.
+     * @see #getProperty
+     */
+    virtual void setProperty(const ::std::string& key, const ::std::string& value) = 0;
+
+    /**
+     * Get a sequence of command-line options that is equivalent to
+     * this property set. Each element of the returned sequence is
+     * a command-line option of the form
+     * <tt>--<em>key</em>=<em>value</em></tt>.
+     * @return The command line options for this property set.
+     */
+    virtual ::Ice::StringSeq getCommandLineOptions() noexcept = 0;
+
+    /**
+     * Convert a sequence of command-line options into properties.
+     * All options that begin with
+     * <tt>--<em>prefix</em>.</tt> are
+     * converted into properties. If the prefix is empty, all options
+     * that begin with <tt>--</tt> are converted to properties.
+     * @param prefix The property prefix, or an empty string to
+     * convert all options starting with <tt>--</tt>.
+     * @param options The command-line options.
+     * @return The command-line options that do not start with the specified
+     * prefix, in their original order.
+     */
+    virtual ::Ice::StringSeq parseCommandLineOptions(const ::std::string& prefix, const StringSeq& options) = 0;
+
+    /**
+     * Convert a sequence of command-line options into properties.
+     * All options that begin with one of the following prefixes
+     * are converted into properties: <tt>--Ice</tt>, <tt>--IceBox</tt>, <tt>--IceGrid</tt>,
+     * <tt>--IcePatch2</tt>, <tt>--IceSSL</tt>, <tt>--IceStorm</tt>, <tt>--Freeze</tt>, and <tt>--Glacier2</tt>.
+     * @param options The command-line options.
+     * @return The command-line options that do not start with one of
+     * the listed prefixes, in their original order.
+     */
+    virtual ::Ice::StringSeq parseIceCommandLineOptions(const StringSeq& options) = 0;
+
+    /**
+     * Load properties from a file.
+     * @param file The property file.
+     */
+    virtual void load(const ::std::string& file) = 0;
+
+    /**
+     * Create a copy of this property set.
+     * @return A copy of this property set.
+     */
+    virtual ::std::shared_ptr<::Ice::Properties> clone() noexcept = 0;
 };
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
+/// \cond INTERNAL
 namespace Ice
 {
 
 using PropertiesPtr = ::std::shared_ptr<Properties>;
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
@@ -132,8 +255,10 @@ namespace Ice
 {
 
 class Properties;
-ICE_API ::Ice::LocalObject* upCast(::Ice::Properties*);
-typedef ::IceInternal::Handle< ::Ice::Properties> PropertiesPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(Properties*);
+/// \endcond
+typedef ::IceInternal::Handle< Properties> PropertiesPtr;
 
 }
 
@@ -145,7 +270,14 @@ namespace IceProxy
 namespace Ice
 {
 
-class ICE_API Properties : public virtual ::Ice::LocalObject
+/**
+ * A property set used to configure Ice and Ice applications.
+ * Properties are key/value pairs, with both keys and values
+ * being strings. By convention, property keys should have the form
+ * <em>application-name</em>\[.<em>category</em>\[.<em>sub-category</em>]].<em>name</em>.
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API Properties : public virtual LocalObject
 {
 public:
 
@@ -153,49 +285,165 @@ public:
 
     virtual ~Properties();
 
-    virtual ::std::string getProperty(const ::std::string&) = 0;
-
-    virtual ::std::string getPropertyWithDefault(const ::std::string&, const ::std::string&) = 0;
-
-    virtual ::Ice::Int getPropertyAsInt(const ::std::string&) = 0;
-
-    virtual ::Ice::Int getPropertyAsIntWithDefault(const ::std::string&, ::Ice::Int) = 0;
-
-    virtual ::Ice::StringSeq getPropertyAsList(const ::std::string&) = 0;
-
-    virtual ::Ice::StringSeq getPropertyAsListWithDefault(const ::std::string&, const ::Ice::StringSeq&) = 0;
-
-    virtual ::Ice::PropertyDict getPropertiesForPrefix(const ::std::string&) = 0;
-
-    virtual void setProperty(const ::std::string&, const ::std::string&) = 0;
-
-    virtual ::Ice::StringSeq getCommandLineOptions() = 0;
-
-    virtual ::Ice::StringSeq parseCommandLineOptions(const ::std::string&, const ::Ice::StringSeq&) = 0;
-
-    virtual ::Ice::StringSeq parseIceCommandLineOptions(const ::Ice::StringSeq&) = 0;
-
-    virtual void load(const ::std::string&) = 0;
-
-    virtual ::Ice::PropertiesPtr clone() = 0;
+    /**
+     * Get a property by key. If the property is not set, an empty
+     * string is returned.
+     * @param key The property key.
+     * @return The property value.
+     * @see #setProperty
+     */
+    virtual ::std::string getProperty(const ::std::string& key) ICE_NOEXCEPT = 0;
+
+    /**
+     * Get a property by key. If the property is not set, the
+     * given default value is returned.
+     * @param key The property key.
+     * @param value The default value to use if the property does not
+     * exist.
+     * @return The property value or the default value.
+     * @see #setProperty
+     */
+    virtual ::std::string getPropertyWithDefault(const ::std::string& key, const ::std::string& value) ICE_NOEXCEPT = 0;
+
+    /**
+     * Get a property as an integer. If the property is not set, 0
+     * is returned.
+     * @param key The property key.
+     * @return The property value interpreted as an integer.
+     * @see #setProperty
+     */
+    virtual Int getPropertyAsInt(const ::std::string& key) ICE_NOEXCEPT = 0;
+
+    /**
+     * Get a property as an integer. If the property is not set, the
+     * given default value is returned.
+     * @param key The property key.
+     * @param value The default value to use if the property does not
+     * exist.
+     * @return The property value interpreted as an integer, or the
+     * default value.
+     * @see #setProperty
+     */
+    virtual Int getPropertyAsIntWithDefault(const ::std::string& key, Int value) ICE_NOEXCEPT = 0;
+
+    /**
+     * Get a property as a list of strings. The strings must be
+     * separated by whitespace or comma. If the property is not set,
+     * an empty list is returned. The strings in the list can contain
+     * whitespace and commas if they are enclosed in single or double
+     * quotes. If quotes are mismatched, an empty list is returned.
+     * Within single quotes or double quotes, you can escape the
+     * quote in question with \, e.g. O'Reilly can be written as
+     * O'Reilly, "O'Reilly" or 'O\'Reilly'.
+     * @param key The property key.
+     * @return The property value interpreted as a list of strings.
+     * @see #setProperty
+     */
+    virtual StringSeq getPropertyAsList(const ::std::string& key) ICE_NOEXCEPT = 0;
+
+    /**
+     * Get a property as a list of strings.  The strings must be
+     * separated by whitespace or comma. If the property is not set,
+     * the default list is returned. The strings in the list can contain
+     * whitespace and commas if they are enclosed in single or double
+     * quotes. If quotes are mismatched, the default list is returned.
+     * Within single quotes or double quotes, you can escape the
+     * quote in question with \, e.g. O'Reilly can be written as
+     * O'Reilly, "O'Reilly" or 'O\'Reilly'.
+     * @param key The property key.
+     * @param value The default value to use if the property is not set.
+     * @return The property value interpreted as list of strings, or the
+     * default value.
+     * @see #setProperty
+     */
+    virtual StringSeq getPropertyAsListWithDefault(const ::std::string& key, const StringSeq& value) ICE_NOEXCEPT = 0;
+
+    /**
+     * Get all properties whose keys begins with
+     * <em>prefix</em>. If
+     * <em>prefix</em> is an empty string,
+     * then all properties are returned.
+     * @param prefix The prefix to search for (empty string if none).
+     * @return The matching property set.
+     */
+    virtual PropertyDict getPropertiesForPrefix(const ::std::string& prefix) ICE_NOEXCEPT = 0;
+
+    /**
+     * Set a property. To unset a property, set it to
+     * the empty string.
+     * @param key The property key.
+     * @param value The property value.
+     * @see #getProperty
+     */
+    virtual void setProperty(const ::std::string& key, const ::std::string& value) = 0;
+
+    /**
+     * Get a sequence of command-line options that is equivalent to
+     * this property set. Each element of the returned sequence is
+     * a command-line option of the form
+     * <tt>--<em>key</em>=<em>value</em></tt>.
+     * @return The command line options for this property set.
+     */
+    virtual StringSeq getCommandLineOptions() ICE_NOEXCEPT = 0;
+
+    /**
+     * Convert a sequence of command-line options into properties.
+     * All options that begin with
+     * <tt>--<em>prefix</em>.</tt> are
+     * converted into properties. If the prefix is empty, all options
+     * that begin with <tt>--</tt> are converted to properties.
+     * @param prefix The property prefix, or an empty string to
+     * convert all options starting with <tt>--</tt>.
+     * @param options The command-line options.
+     * @return The command-line options that do not start with the specified
+     * prefix, in their original order.
+     */
+    virtual StringSeq parseCommandLineOptions(const ::std::string& prefix, const StringSeq& options) = 0;
+
+    /**
+     * Convert a sequence of command-line options into properties.
+     * All options that begin with one of the following prefixes
+     * are converted into properties: <tt>--Ice</tt>, <tt>--IceBox</tt>, <tt>--IceGrid</tt>,
+     * <tt>--IcePatch2</tt>, <tt>--IceSSL</tt>, <tt>--IceStorm</tt>, <tt>--Freeze</tt>, and <tt>--Glacier2</tt>.
+     * @param options The command-line options.
+     * @return The command-line options that do not start with one of
+     * the listed prefixes, in their original order.
+     */
+    virtual StringSeq parseIceCommandLineOptions(const StringSeq& options) = 0;
+
+    /**
+     * Load properties from a file.
+     * @param file The property file.
+     */
+    virtual void load(const ::std::string& file) = 0;
+
+    /**
+     * Create a copy of this property set.
+     * @return A copy of this property set.
+     */
+    virtual PropertiesPtr clone() ICE_NOEXCEPT = 0;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const Properties& lhs, const Properties& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) == static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) == static_cast<const LocalObject&>(rhs);
 }
 
 inline bool operator<(const Properties& lhs, const Properties& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) < static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) < static_cast<const LocalObject&>(rhs);
 }
+/// \endcond
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
 #endif