INTEGRATION: CWS sb18 (1.1.2); FILE ADDED

2004/04/28 08:56:43 sb 1.1.2.2: #i21150# Documentation improvements.
2004/04/22 08:20:09 sb 1.1.2.1: #i21150# Expanded unotypesort.hxx to unotype.hxx.

1 files changed, 144 insertions, 0 deletions

diff --git a/codemaker/inc/codemaker/unotype.hxx b/codemaker/inc/codemaker/unotype.hxx
new file mode 100644
index 000000000..d73a3fa84
--- /dev/null
+++ b/codemaker/inc/codemaker/unotype.hxx
@@ -0,0 +1,144 @@
+/*************************************************************************
+ *
+ *  $RCSfile: unotype.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: obo $ $Date: 2004-06-04 03:09:35 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (the "License"); You may not use this file
+ *  except in compliance with the License. You may obtain a copy of the
+ *  License at http://www.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef INCLUDED_codemaker_unotype_hxx
+#define INCLUDED_codemaker_unotype_hxx
+
+#include "sal/types.h"
+
+#include <vector>
+
+namespace rtl { class OString; }
+
+namespace codemaker {
+
+namespace UnoType {
+    /**
+       An enumeration of all the sorts of UNO types.
+
+       All complex UNO types are subsumed under SORT_COMPLEX.
+     */
+    enum Sort {
+        SORT_VOID,
+        SORT_BOOLEAN,
+        SORT_BYTE,
+        SORT_SHORT,
+        SORT_UNSIGNED_SHORT,
+        SORT_LONG,
+        SORT_UNSIGNED_LONG,
+        SORT_HYPER,
+        SORT_UNSIGNED_HYPER,
+        SORT_FLOAT,
+        SORT_DOUBLE,
+        SORT_CHAR,
+        SORT_STRING,
+        SORT_TYPE,
+        SORT_ANY,
+        SORT_COMPLEX
+    };
+
+    /**
+       Maps from a binary UNO type name or UNO type registry name to its type
+       sort.
+
+       @param type a binary UNO type name or UNO type registry name
+
+       @return the sort of the UNO type denoted by the given type; the detection
+       of the correct sort is purely syntactical (especially, if the given input
+       is a UNO type registry name that denotes something other than a UNO type,
+       SORT_COMPLEX is returned)
+     */
+    Sort getSort(rtl::OString const & type);
+
+    /**
+       Determines whether a UNO type name or UNO type registry name denotes a
+       UNO sequence type.
+
+       @param type a binary UNO type name or UNO type registry name
+
+       @return true iff the given type denotes a UNO sequence type; the
+       detection is purely syntactical
+     */
+    bool isSequenceType(rtl::OString const & type);
+
+    /**
+       Decomposes a UNO type name or UNO type registry name.
+
+       @param type a binary UNO type name or UNO type registry name
+
+       @param rank if non-null, returns the rank of the denoted UNO type (which
+       is zero for any given type that does not denote a UNO sequence type)
+
+       @param arguments if non-null, the type arguments are stripped from an
+       instantiated polymorphic struct type and returned via this parameter (in
+       the correct order); if null, type arguments are not stripped from
+       instantiated polymorphic struct types
+
+       @return the base part of the given type
+     */
+    rtl::OString decompose(
+        rtl::OString const & type, sal_Int32 * rank = 0,
+        std::vector< rtl::OString > * arguments = 0);
+}
+
+}
+
+#endif