diff options
author | Daniel Boelzle <dbo@openoffice.org> | 2001-11-09 08:14:31 +0000 |
---|---|---|
committer | Daniel Boelzle <dbo@openoffice.org> | 2001-11-09 08:14:31 +0000 |
commit | a46e111f65bbc1bfa8b4e6ad9488dba2e0762256 (patch) | |
tree | 5fc508221529730abfce8a0de12014858d77f151 /cppu | |
parent | *** empty log message *** (diff) | |
download | core-a46e111f65bbc1bfa8b4e6ad9488dba2e0762256.tar.gz core-a46e111f65bbc1bfa8b4e6ad9488dba2e0762256.zip |
#88337# documentation review
Diffstat (limited to 'cppu')
26 files changed, 241 insertions, 266 deletions
diff --git a/cppu/inc/com/sun/star/uno/Any.h b/cppu/inc/com/sun/star/uno/Any.h index dc6132421bfc..9d157ced647b 100644 --- a/cppu/inc/com/sun/star/uno/Any.h +++ b/cppu/inc/com/sun/star/uno/Any.h @@ -2,9 +2,9 @@ * * $RCSfile: Any.h,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: dbo $ $Date: 2001-08-21 09:17:07 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,16 +76,12 @@ #endif -/** */ //for docpp namespace com { -/** */ //for docpp namespace sun { -/** */ //for docpp namespace star { -/** */ //for docpp namespace uno { @@ -101,12 +97,16 @@ class Any : public uno_Any { public: // these are here to force memory de/allocation to sal lib. + /** @internal */ inline static void * SAL_CALL operator new ( size_t nSize ) SAL_THROW( () ) { return ::rtl_allocateMemory( nSize ); } + /** @internal */ inline static void SAL_CALL operator delete ( void * pMem ) SAL_THROW( () ) { ::rtl_freeMemory( pMem ); } + /** @internal */ inline static void * SAL_CALL operator new ( size_t, void * pMem ) SAL_THROW( () ) { return pMem; } + /** @internal */ inline static void SAL_CALL operator delete ( void *, void * ) SAL_THROW( () ) {} @@ -245,6 +245,7 @@ public: /** Template function to generically construct an any from a C++ value. + @tplparam C value type @param value a value @return an any */ @@ -256,6 +257,7 @@ class Type; /** Template binary <<= operator to set the value of an any. + @tplparam C value type @param rAny destination any (left side) @param value source value (right side) */ @@ -265,6 +267,7 @@ inline void SAL_CALL operator <<= ( Any & rAny, const C & value ) SAL_THROW( () If the any does not contain a value that can be assigned without data loss, then this operation will fail returning false. + @tplparam C value type @param rAny source any (left side) @param value destination value (right side) @return true if assignment was possible without data loss @@ -277,6 +280,7 @@ inline sal_Bool SAL_CALL operator >>= ( const Any & rAny, C & value ) SAL_THROW( This operator can be implemented as template member function, if all supported compilers can cope with template member functions. + @tplparam C value type @param rAny another any (left side) @param value a value (right side) @return true if values are equal, false otherwise @@ -288,6 +292,7 @@ inline sal_Bool SAL_CALL operator == ( const Any & rAny, const C & value ) SAL_T This operator can be implemented as template member function, if all supported compilers can cope with template member functions. + @tplparam C value type @param rAny another any (left side) @param value a value (right side) @return true if values are unequal, false otherwise diff --git a/cppu/inc/com/sun/star/uno/Any.hxx b/cppu/inc/com/sun/star/uno/Any.hxx index a10f0c4094e7..b15f285ea03e 100644 --- a/cppu/inc/com/sun/star/uno/Any.hxx +++ b/cppu/inc/com/sun/star/uno/Any.hxx @@ -2,9 +2,9 @@ * * $RCSfile: Any.hxx,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mh $ $Date: 2001-10-01 16:06:52 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,16 +78,12 @@ #endif -/** */ //for docpp namespace com { -/** */ //for docpp namespace sun { -/** */ //for docpp namespace star { -/** */ //for docpp namespace uno { diff --git a/cppu/inc/com/sun/star/uno/Reference.h b/cppu/inc/com/sun/star/uno/Reference.h index 054ea5f4e879..abaeed812514 100644 --- a/cppu/inc/com/sun/star/uno/Reference.h +++ b/cppu/inc/com/sun/star/uno/Reference.h @@ -2,9 +2,9 @@ * * $RCSfile: Reference.h,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: dbo $ $Date: 2001-10-11 14:09:49 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,16 +66,12 @@ #endif -/** */ //for docpp namespace com { -/** */ //for docpp namespace sun { -/** */ //for docpp namespace star { -/** */ //for docpp namespace uno { @@ -83,8 +79,9 @@ class RuntimeException; class XInterface; class Any; -/** DEPRECATED: use SAL_NO_ACQUIRE - Enum defining UNO_REF_NO_ACQUIRE for setting reference without acquiring a given interface. +/** Enum defining UNO_REF_NO_ACQUIRE for setting reference without acquiring a given interface. + Deprecated, please use SAL_NO_ACQUIRE. + @deprecated */ enum __UnoReference_NoAcquire { @@ -155,7 +152,6 @@ public: }; /** Enum defining UNO_QUERY and UNO_REF_QUERY for query interface constructor of reference template. - */ enum __UnoReference_Query { @@ -183,13 +179,17 @@ class Reference : public BaseReference public: // these are here to force memory de/allocation to sal lib. - static void * SAL_CALL operator new ( size_t nSize ) SAL_THROW( () ) + /** @internal */ + inline static void * SAL_CALL operator new ( size_t nSize ) SAL_THROW( () ) { return ::rtl_allocateMemory( nSize ); } - static void SAL_CALL operator delete ( void * pMem ) SAL_THROW( () ) + /** @internal */ + inline static void SAL_CALL operator delete ( void * pMem ) SAL_THROW( () ) { ::rtl_freeMemory( pMem ); } - static void * SAL_CALL operator new ( size_t, void * pMem ) SAL_THROW( () ) + /** @internal */ + inline static void * SAL_CALL operator new ( size_t, void * pMem ) SAL_THROW( () ) { return pMem; } - static void SAL_CALL operator delete ( void *, void * ) SAL_THROW( () ) + /** @internal */ + inline static void SAL_CALL operator delete ( void *, void * ) SAL_THROW( () ) {} /** Destructor: Releases interface if set. @@ -217,9 +217,10 @@ public: @param dummy SAL_NO_ACQUIRE to force obvious distinction to other constructors */ inline Reference( interface_type * pInterface, __sal_NoAcquire ) SAL_THROW( () ); - /** DEPRECATED: use SAL_NO_ACQUIRE version - Constructor: Sets given interface pointer without acquiring it. + /** Constructor: Sets given interface pointer without acquiring it. + Deprecated, please use SAL_NO_ACQUIRE version. + @deprecated @param pInterface another reference @param dummy UNO_REF_NO_ACQUIRE to force obvious distinction to other constructors */ @@ -288,9 +289,10 @@ public: @return true, if non-null interface was set */ inline sal_Bool SAL_CALL set( interface_type * pInterface, __sal_NoAcquire ) SAL_THROW( () ); - /** DEPRECATED: use SAL_NO_ACQUIRE version - Sets interface pointer without acquiring it. An interface already set will be released. + /** Sets interface pointer without acquiring it. An interface already set will be released. + Deprecated, please use SAL_NO_ACQUIRE version. + @deprecated @param pInterface an interface pointer @return true, if non-null interface was set */ diff --git a/cppu/inc/com/sun/star/uno/Reference.hxx b/cppu/inc/com/sun/star/uno/Reference.hxx index cb856825cfeb..c9d4fdb0c1ec 100644 --- a/cppu/inc/com/sun/star/uno/Reference.hxx +++ b/cppu/inc/com/sun/star/uno/Reference.hxx @@ -2,9 +2,9 @@ * * $RCSfile: Reference.hxx,v $ * - * $Revision: 1.12 $ + * $Revision: 1.13 $ * - * last change: $Author: dbo $ $Date: 2001-10-11 14:09:49 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,16 +71,12 @@ #include <com/sun/star/uno/genfunc.hxx> #endif -/** */ //for docpp namespace com { -/** */ //for docpp namespace sun { -/** */ //for docpp namespace star { -/** */ //for docpp namespace uno { diff --git a/cppu/inc/com/sun/star/uno/Sequence.h b/cppu/inc/com/sun/star/uno/Sequence.h index 79f018175b79..a4bae5e6ff31 100644 --- a/cppu/inc/com/sun/star/uno/Sequence.h +++ b/cppu/inc/com/sun/star/uno/Sequence.h @@ -2,9 +2,9 @@ * * $RCSfile: Sequence.h,v $ * - * $Revision: 1.13 $ + * $Revision: 1.14 $ * - * last change: $Author: dbo $ $Date: 2001-10-16 08:33:46 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,16 +81,12 @@ namespace rtl class ByteSequence; } -/** */ //for docpp namespace com { -/** */ //for docpp namespace sun { -/** */ //for docpp namespace star { -/** */ //for docpp namespace uno { @@ -98,26 +94,36 @@ namespace uno C++ Sequences are reference counted and shared, so the sequence keeps a handle to its data. To keep value semantics, copies are only generated if the sequence is to be modified (new handle). + + @tplparam E element type of sequence */ template< class E > class Sequence { /** sequence handle + @internal */ uno_Sequence * _pSequence; public: // these are here to force memory de/allocation to sal lib. + /** @internal */ inline static void * SAL_CALL operator new ( size_t nSize ) SAL_THROW( () ) { return ::rtl_allocateMemory( nSize ); } + /** @internal */ inline static void SAL_CALL operator delete ( void * pMem ) SAL_THROW( () ) { ::rtl_freeMemory( pMem ); } + /** @internal */ inline static void * SAL_CALL operator new ( size_t, void * pMem ) SAL_THROW( () ) { return pMem; } + /** @internal */ inline static void SAL_CALL operator delete ( void *, void * ) SAL_THROW( () ) {} - // static pointer to typelib type + /** Static pointer to typelib type of sequence. + Don't use directly, call getCppuType(). + @internal + */ static typelib_TypeDescriptionReference * s_pType; /** typedefs the element type of the sequence @@ -254,22 +260,25 @@ inline ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL toUnoSequence( /** Gets the meta type of IDL sequence. + @tplparam E element type of sequence @param dummy typed pointer for function signature @return type of IDL sequence */ -template< class S > +template< class E > inline const ::com::sun::star::uno::Type & -SAL_CALL getCppuType( const ::com::sun::star::uno::Sequence< S > * ) SAL_THROW( () ); +SAL_CALL getCppuType( const ::com::sun::star::uno::Sequence< E > * ) SAL_THROW( () ); /** Gets the meta type of IDL sequence. - THE GIVEN ELEMENT TYPE MUST BE THE SAME AS THE CPP_UNO TYPE OF THE TEMPLATE ARGUMENT! This function has been introduced, because one cannot get the (templated) cppu type out - of C++ array types. Array types have special getCppuArrayTypeN<>() functions. + of C++ array types. Array types have special getCppuArrayTypeN() functions. + @attention + the given element type must be the same as the template argument type! + @tplparam E element type of sequence @param rElementType element type of sequence @return type of IDL sequence */ -template< class S > +template< class E > inline const ::com::sun::star::uno::Type & SAL_CALL getCppuSequenceType( const ::com::sun::star::uno::Type & rElementType ) SAL_THROW( () ); diff --git a/cppu/inc/com/sun/star/uno/Sequence.hxx b/cppu/inc/com/sun/star/uno/Sequence.hxx index c381ed3dba51..b25ff3170806 100644 --- a/cppu/inc/com/sun/star/uno/Sequence.hxx +++ b/cppu/inc/com/sun/star/uno/Sequence.hxx @@ -2,9 +2,9 @@ * * $RCSfile: Sequence.hxx,v $ * - * $Revision: 1.13 $ + * $Revision: 1.14 $ * - * last change: $Author: dbo $ $Date: 2001-09-06 10:25:04 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,16 +81,12 @@ #endif -/** */ //for docpp namespace com { -/** */ //for docpp namespace sun { -/** */ //for docpp namespace star { -/** */ //for docpp namespace uno { //__________________________________________________________________________________________________ @@ -224,35 +220,35 @@ inline ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL toUnoSequence( } // generic sequence template -template< class S > +template< class E > inline const ::com::sun::star::uno::Type & -SAL_CALL getCppuType( const ::com::sun::star::uno::Sequence< S > * ) SAL_THROW( () ) +SAL_CALL getCppuType( const ::com::sun::star::uno::Sequence< E > * ) SAL_THROW( () ) { - if (! ::com::sun::star::uno::Sequence< S >::s_pType) + if (! ::com::sun::star::uno::Sequence< E >::s_pType) { const ::com::sun::star::uno::Type & rElementType = ::getCppuType( - (::com::sun::star::uno::Sequence< S >::ElementType *)0 ); + (::com::sun::star::uno::Sequence< E >::ElementType *)0 ); ::typelib_static_sequence_type_init( - & ::com::sun::star::uno::Sequence< S >::s_pType, + & ::com::sun::star::uno::Sequence< E >::s_pType, rElementType.getTypeLibType() ); } return * reinterpret_cast< const ::com::sun::star::uno::Type * >( - & ::com::sun::star::uno::Sequence< S >::s_pType ); + & ::com::sun::star::uno::Sequence< E >::s_pType ); } // generic sequence template for given element type (e.g. C++ arrays) -template< class S > +template< class E > inline const ::com::sun::star::uno::Type & SAL_CALL getCppuSequenceType( const ::com::sun::star::uno::Type & rElementType ) SAL_THROW( () ) { - if (! ::com::sun::star::uno::Sequence< S >::s_pType) + if (! ::com::sun::star::uno::Sequence< E >::s_pType) { ::typelib_static_sequence_type_init( - & ::com::sun::star::uno::Sequence< S >::s_pType, + & ::com::sun::star::uno::Sequence< E >::s_pType, rElementType.getTypeLibType() ); } return * reinterpret_cast< const ::com::sun::star::uno::Type * >( - & ::com::sun::star::uno::Sequence< S >::s_pType ); + & ::com::sun::star::uno::Sequence< E >::s_pType ); } #if ((defined(__SUNPRO_CC) && (__SUNPRO_CC == 0x500)) || (defined(__GNUC__) && defined(__APPLE__))) diff --git a/cppu/inc/com/sun/star/uno/Type.h b/cppu/inc/com/sun/star/uno/Type.h index 25782a66e1c4..771fdc5058e7 100644 --- a/cppu/inc/com/sun/star/uno/Type.h +++ b/cppu/inc/com/sun/star/uno/Type.h @@ -2,9 +2,9 @@ * * $RCSfile: Type.h,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: dbo $ $Date: 2001-08-21 09:17:07 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,16 +79,12 @@ #endif -/** */ //for docpp namespace com { -/** */ //for docpp namespace sun { -/** */ //for docpp namespace star { -/** */ //for docpp namespace uno { @@ -106,21 +102,28 @@ enum __UnoType_NoAcquire i.e. a type name and its type class. Internally the type holds a C type description reference of the runtime. You can obtain a full type description of a type by calling member function getDescription(). + + @see typelib_TypeDescriptionReference */ class Type { /** the C typelib reference pointer + @internal */ typelib_TypeDescriptionReference * _pType; public: // these are here to force memory de/allocation to sal lib. + /** @internal */ inline static void * SAL_CALL operator new ( size_t nSize ) SAL_THROW( () ) { return ::rtl_allocateMemory( nSize ); } + /** @internal */ inline static void SAL_CALL operator delete ( void * pMem ) SAL_THROW( () ) { ::rtl_freeMemory( pMem ); } + /** @internal */ inline static void * SAL_CALL operator new ( size_t, void * pMem ) SAL_THROW( () ) { return pMem; } + /** @internal */ inline static void SAL_CALL operator delete ( void *, void * ) SAL_THROW( () ) {} diff --git a/cppu/inc/com/sun/star/uno/Type.hxx b/cppu/inc/com/sun/star/uno/Type.hxx index ff554ab5f249..17f160cdd604 100644 --- a/cppu/inc/com/sun/star/uno/Type.hxx +++ b/cppu/inc/com/sun/star/uno/Type.hxx @@ -2,9 +2,9 @@ * * $RCSfile: Type.hxx,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-30 13:36:46 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,16 +70,12 @@ #endif -/** */ //for docpp namespace com { -/** */ //for docpp namespace sun { -/** */ //for docpp namespace star { -/** */ //for docpp namespace uno { diff --git a/cppu/inc/com/sun/star/uno/genfunc.h b/cppu/inc/com/sun/star/uno/genfunc.h index ded3e6639a7c..8a320b40225f 100644 --- a/cppu/inc/com/sun/star/uno/genfunc.h +++ b/cppu/inc/com/sun/star/uno/genfunc.h @@ -2,9 +2,9 @@ * * $RCSfile: genfunc.h,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: dbo $ $Date: 2001-09-06 10:25:04 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -63,16 +63,12 @@ typedef struct _typelib_TypeDescriptionReference typelib_TypeDescriptionReference; -/** */ //for docpp namespace com { -/** */ //for docpp namespace sun { -/** */ //for docpp namespace star { -/** */ //for docpp namespace uno { diff --git a/cppu/inc/com/sun/star/uno/genfunc.hxx b/cppu/inc/com/sun/star/uno/genfunc.hxx index 3304a83f70a2..2e070c02fd99 100644 --- a/cppu/inc/com/sun/star/uno/genfunc.hxx +++ b/cppu/inc/com/sun/star/uno/genfunc.hxx @@ -2,9 +2,9 @@ * * $RCSfile: genfunc.hxx,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: dbo $ $Date: 2001-09-06 10:25:04 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,16 +69,12 @@ #endif -/** */ //for docpp namespace com { -/** */ //for docpp namespace sun { -/** */ //for docpp namespace star { -/** */ //for docpp namespace uno { diff --git a/cppu/inc/typelib/typedescription.h b/cppu/inc/typelib/typedescription.h index a8d4f47a49f9..81cbb3976000 100644 --- a/cppu/inc/typelib/typedescription.h +++ b/cppu/inc/typelib/typedescription.h @@ -2,9 +2,9 @@ * * $RCSfile: typedescription.h,v $ * - * $Revision: 1.10 $ + * $Revision: 1.11 $ * - * last change: $Author: dbo $ $Date: 2001-09-06 14:53:29 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -683,19 +683,21 @@ void SAL_CALL typelib_typedescription_revokeCallback( /*----------------------------------------------------------------------------*/ /*----------------------------------------------------------------------------*/ -/* Returns true, if the type description reference may lose the type description. Otherwise +/** Returns true, if the type description reference may lose the type description. Otherwise pType is a valid pointer and cannot be discarded through the lifetime of this reference. Remark: If the pWeakObj of the type is set too, you can avoid the call of ...getDescription(...) and use the description directly. pWeakObj == 0 means, that the description is not initialized. + @internal */ #define TYPELIB_TYPEDESCRIPTIONREFERENCE_ISREALLYWEAK( eTypeClass ) \ ((eTypeClass) == typelib_TypeClass_INTERFACE_METHOD || \ (eTypeClass) == typelib_TypeClass_INTERFACE_ATTRIBUTE) -/* Gets a description from the reference. The description may not be locked by this call. +/** Gets a description from the reference. The description may not be locked by this call. You must use the TYPELIB_DANGER_RELEASE macro to release the description fetched with this macro. + @internal */ #define TYPELIB_DANGER_GET( ppDescription, pTypeRef ) \ { \ @@ -717,7 +719,8 @@ void SAL_CALL typelib_typedescription_revokeCallback( } \ } -/* Releases the description previouse fetched by TYPELIB_DANGER_GET. +/** Releases the description previouse fetched by TYPELIB_DANGER_GET. + @internal */ #define TYPELIB_DANGER_RELEASE( pDescription ) \ { \ diff --git a/cppu/inc/typelib/typedescription.hxx b/cppu/inc/typelib/typedescription.hxx index c194b5f81e38..9ef3b311776e 100644 --- a/cppu/inc/typelib/typedescription.hxx +++ b/cppu/inc/typelib/typedescription.hxx @@ -2,9 +2,9 @@ * * $RCSfile: typedescription.hxx,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: dbo $ $Date: 2001-08-21 09:17:07 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,6 +61,9 @@ #ifndef _TYPELIB_TYPEDESCRIPTION_HXX_ #define _TYPELIB_TYPEDESCRIPTION_HXX_ +#ifndef _RTL_ALLOC_H_ +#include <rtl/alloc.h> +#endif #ifndef _RTL_USTRING_ #include <rtl/ustring> #endif @@ -71,21 +74,20 @@ #include <typelib/typedescription.h> #endif -/** */ //for docpp + namespace com { -/** */ //for docpp namespace sun { -/** */ //for docpp namespace star { -/** */ //for docpp namespace uno { /** C++ wrapper for typelib_TypeDescription. Constructors by name, type, type description reference will get the full type description. + + @see typelib_TypeDescription */ class TypeDescription { @@ -94,6 +96,20 @@ class TypeDescription mutable typelib_TypeDescription * _pTypeDescr; public: + // these are here to force memory de/allocation to sal lib. + /** @internal */ + inline static void * SAL_CALL operator new ( size_t nSize ) SAL_THROW( () ) + { return ::rtl_allocateMemory( nSize ); } + /** @internal */ + inline static void SAL_CALL operator delete ( void * pMem ) SAL_THROW( () ) + { ::rtl_freeMemory( pMem ); } + /** @internal */ + inline static void * SAL_CALL operator new ( size_t, void * pMem ) SAL_THROW( () ) + { return pMem; } + /** @internal */ + inline static void SAL_CALL operator delete ( void *, void * ) SAL_THROW( () ) + {} + /** Constructor: @param pTypeDescr a type description diff --git a/cppu/inc/typelib/uik.h b/cppu/inc/typelib/uik.h index 9b4fc6488de0..6ca70fa1307f 100644 --- a/cppu/inc/typelib/uik.h +++ b/cppu/inc/typelib/uik.h @@ -2,9 +2,9 @@ * * $RCSfile: uik.h,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: dbo $ $Date: 2001-08-21 09:17:07 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,7 +71,7 @@ # pragma pack(8) #endif -/** Binary typelib uik struct. Currently not used anymore. +/** Binary typelib uik struct. Internally not used anymore. */ typedef struct _typelib_Uik { diff --git a/cppu/inc/uno/cuno.h b/cppu/inc/uno/cuno.h index cb818094e97a..a235f4974d3e 100644 --- a/cppu/inc/uno/cuno.h +++ b/cppu/inc/uno/cuno.h @@ -2,9 +2,9 @@ * * $RCSfile: cuno.h,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: dbo $ $Date: 2001-08-21 09:17:07 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,7 +69,15 @@ #define CUNO_ERROR_CALL_FAILED (1 << 31) #define CUNO_ERROR_EXCEPTION (1 | CUNO_ERROR_CALL_FAILED) +/** macro to call on a C interface + + @param interface_pointer interface pointer +*/ #define CUNO_CALL( interface_pointer ) (*interface_pointer) +/** macro to test if an exception was signalled. + + @param return_code return code of call +*/ #define CUNO_EXCEPTION_OCCURED( return_code ) (0 != ((return_code) & CUNO_ERROR_EXCEPTION)) typedef sal_Int32 cuno_ErrorCode; diff --git a/cppu/inc/uno/current_context.h b/cppu/inc/uno/current_context.h index f2edc275c0f6..97f31f7c8b46 100644 --- a/cppu/inc/uno/current_context.h +++ b/cppu/inc/uno/current_context.h @@ -2,9 +2,9 @@ * * $RCSfile: current_context.h,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: dbo $ $Date: 2001-05-07 15:06:56 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,8 +61,8 @@ #ifndef _UNO_CURRENT_CONTEXT_H_ #define _UNO_CURRENT_CONTEXT_H_ -#ifndef _UNO_DISPATCHER_H_ -#include <uno/dispatcher.h> +#ifndef _RTL_USTRING_H_ +#include <rtl/ustring.h> #endif #ifdef __cplusplus @@ -71,6 +71,9 @@ extern "C" #endif /** Gets the current task's context. + @attention + Don't spread the returned interface around to other threads. Every thread has its own + current context. @param ppCurrentContext inout param current context of type com.sun.star.uno.XCurrentContext @param pEnvTypeName type name of returned interface's environment diff --git a/cppu/inc/uno/current_context.hxx b/cppu/inc/uno/current_context.hxx index 862c1fc33c2d..0784dd47b813 100644 --- a/cppu/inc/uno/current_context.hxx +++ b/cppu/inc/uno/current_context.hxx @@ -2,9 +2,9 @@ * * $RCSfile: current_context.hxx,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: dbo $ $Date: 2001-08-22 11:03:23 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -62,25 +62,23 @@ #define _UNO_CURRENT_CONTEXT_HXX_ #include <uno/current_context.h> -#include <cppu/macros.hxx> #include <com/sun/star/uno/XCurrentContext.hpp> -/** */ //for docpp namespace com { -/** */ //for docpp namespace sun { -/** */ //for docpp namespace star { -/** */ //for docpp namespace uno { /** Getting the current context. + @attention + Don't spread the returned interface around to other threads. Every thread has its own + current context. @return current context or null ref, if none is set */ @@ -105,13 +103,18 @@ inline bool SAL_CALL setCurrentContext( return (::uno_setCurrentContext( xContext.get(), aEnvTypeName.pData, 0 ) != sal_False); } -/** Objects of this class are used for applying a current context until they are destructed, - i.e. the ctor of this class saves the previous and sets the given context while the dtor - restores the previous one upon destruction. +/** Objects of this class are used for applying a current context until they are destructed, i.e. + the ctor of this class saves the previous and sets the given context while the dtor restores + the previous one upon destruction. */ class ContextLayer { + /** this C++ environment type name. + @internal + */ + ::rtl::OUString m_aEnvTypeName; /** previous context + @internal */ Reference< XCurrentContext > m_xPreviousContext; @@ -137,17 +140,16 @@ public: //__________________________________________________________________________________________________ inline ContextLayer::ContextLayer( Reference< XCurrentContext > const & xNewContext ) SAL_THROW( () ) + : m_aEnvTypeName( RTL_CONSTASCII_USTRINGPARAM(CPPU_CURRENT_LANGUAGE_BINDING_NAME) ) { - ::rtl::OUString aEnvTypeName( RTL_CONSTASCII_USTRINGPARAM(CPPU_CURRENT_LANGUAGE_BINDING_NAME) ); - ::uno_getCurrentContext( (void **)&m_xPreviousContext, aEnvTypeName.pData, 0 ); - ::uno_setCurrentContext( xNewContext.get(), aEnvTypeName.pData, 0 ); + ::uno_getCurrentContext( (void **)&m_xPreviousContext, m_aEnvTypeName.pData, 0 ); + ::uno_setCurrentContext( xNewContext.get(), m_aEnvTypeName.pData, 0 ); } //__________________________________________________________________________________________________ inline ContextLayer::~ContextLayer() SAL_THROW( () ) { - ::rtl::OUString aEnvTypeName( RTL_CONSTASCII_USTRINGPARAM(CPPU_CURRENT_LANGUAGE_BINDING_NAME) ); - ::uno_setCurrentContext( m_xPreviousContext.get(), aEnvTypeName.pData, 0 ); + ::uno_setCurrentContext( m_xPreviousContext.get(), m_aEnvTypeName.pData, 0 ); } } diff --git a/cppu/inc/uno/environment.hxx b/cppu/inc/uno/environment.hxx index b0755036fda9..0c4571abf5a4 100644 --- a/cppu/inc/uno/environment.hxx +++ b/cppu/inc/uno/environment.hxx @@ -2,9 +2,9 @@ * * $RCSfile: environment.hxx,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: dbo $ $Date: 2001-08-21 09:17:07 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,6 +61,9 @@ #ifndef _UNO_ENVIRONMENT_HXX_ #define _UNO_ENVIRONMENT_HXX_ +#ifndef _RTL_ALLOC_H_ +#include <rtl/alloc.h> +#endif #ifndef _RTL_USTRING_HXX_ #include <rtl/ustring.hxx> #endif @@ -83,6 +86,8 @@ namespace uno { /** C++ wrapper for binary C uno_Environment. + + @see uno_Environment */ class Environment { @@ -91,6 +96,20 @@ class Environment uno_Environment * _pEnv; public: + // these are here to force memory de/allocation to sal lib. + /** @internal */ + inline static void * SAL_CALL operator new ( size_t nSize ) SAL_THROW( () ) + { return ::rtl_allocateMemory( nSize ); } + /** @internal */ + inline static void SAL_CALL operator delete ( void * pMem ) SAL_THROW( () ) + { ::rtl_freeMemory( pMem ); } + /** @internal */ + inline static void * SAL_CALL operator new ( size_t, void * pMem ) SAL_THROW( () ) + { return pMem; } + /** @internal */ + inline static void SAL_CALL operator delete ( void *, void * ) SAL_THROW( () ) + {} + /** Constructor: acquires given environment @param pEnv environment diff --git a/cppu/inc/uno/lbnames.h b/cppu/inc/uno/lbnames.h index 5d503fdf4efa..524d760d96a7 100644 --- a/cppu/inc/uno/lbnames.h +++ b/cppu/inc/uno/lbnames.h @@ -2,9 +2,9 @@ * * $RCSfile: lbnames.h,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: dbo $ $Date: 2001-10-26 08:14:51 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,12 +79,12 @@ #elif defined (__SUNPRO_CC) #if (__SUNPRO_CC < 0x500) #error "sunpro cc must be at least 5.x" -provoking error here, because sunpro PP ignores #error +provoking error here, because PP ignores #error #elif (__SUNPRO_CC < 0x600) #define __CPPU_ENV sunpro5 #else #error "sunpro cc version must be 5.x" -provoking error here, because sunpro PP ignores #error +provoking error here, because PP ignores #error #endif /* defined (__SUNPRO_CC) */ /* g++ 2.x, 3.0 */ #elif defined (__GNUC__) @@ -111,7 +111,7 @@ provoking error here, because sunpro PP ignores #error /* test: whether given CPPU_ENV matches expected one */ #if (CPPU_ENV != __CPPU_ENV) #error "CPPU_ENV: unexpected env!" -provoking error here, because sunpro PP ignores #error +provoking error here, because PP ignores #error #endif #define CPPU_STRINGIFY_EX( x ) #x @@ -121,7 +121,7 @@ provoking error here, because sunpro PP ignores #error #else #error "No supported C++ compiler environment." -provoking error here, because sunpro PP ignores #error +provoking error here, because PP ignores #error #endif /* CPPU_ENV */ #endif /** __cplusplus */ diff --git a/cppu/inc/uno/mapping.hxx b/cppu/inc/uno/mapping.hxx index 50173946a362..0b9a699d5365 100644 --- a/cppu/inc/uno/mapping.hxx +++ b/cppu/inc/uno/mapping.hxx @@ -2,9 +2,9 @@ * * $RCSfile: mapping.hxx,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: dbo $ $Date: 2001-08-21 09:17:07 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,6 +64,9 @@ #ifndef _CPPU_MACROS_HXX_ #include <cppu/macros.hxx> #endif +#ifndef _RTL_ALLOC_H_ +#include <rtl/alloc.h> +#endif #ifndef _RTL_USTRING_HXX_ #include <rtl/ustring.hxx> #endif @@ -77,31 +80,44 @@ #include <com/sun/star/uno/Reference.hxx> #endif + typedef struct _typelib_TypeDescription typelib_TypeDescription; typedef struct _typelib_InterfaceTypeDescription typelib_InterfaceTypeDescription; typedef struct _uno_Interface uno_Interface; typedef struct _uno_Environment uno_Environment; -/** */ //for docpp namespace com { -/** */ //for docpp namespace sun { -/** */ //for docpp namespace star { -/** */ //for docpp namespace uno { /** C++ wrapper for C uno_Mapping. + + @see uno_Mapping */ class Mapping { uno_Mapping * _pMapping; public: + // these are here to force memory de/allocation to sal lib. + /** @internal */ + inline static void * SAL_CALL operator new ( size_t nSize ) SAL_THROW( () ) + { return ::rtl_allocateMemory( nSize ); } + /** @internal */ + inline static void SAL_CALL operator delete ( void * pMem ) SAL_THROW( () ) + { ::rtl_freeMemory( pMem ); } + /** @internal */ + inline static void * SAL_CALL operator new ( size_t, void * pMem ) SAL_THROW( () ) + { return pMem; } + /** @internal */ + inline static void SAL_CALL operator delete ( void *, void * ) SAL_THROW( () ) + {} + /** Holds a mapping from the specified source to the specified destination by environment type names. @@ -310,7 +326,13 @@ inline void * Mapping::mapInterface( return pOut; } -//-------------------------------------------------------------------------------------------------- +/** Maps an binary C UNO interface to be used in the currently used compiler environment. + + @tplparam C interface type + @param ppRet inout returned interface pointer + @param pUnoI binary C UNO interface + @return true if successful, false otherwise +*/ template< class C > inline sal_Bool mapToCpp( Reference< C > * ppRet, uno_Interface * pUnoI ) SAL_THROW( () ) { @@ -321,7 +343,13 @@ inline sal_Bool mapToCpp( Reference< C > * ppRet, uno_Interface * pUnoI ) SAL_TH aMapping.mapInterface( (void **)ppRet, pUnoI, ::getCppuType( ppRet ) ); return (0 != *ppRet); } -//-------------------------------------------------------------------------------------------------- +/** Maps an UNO interface of the currently used compiler environment to binary C UNO. + + @tplparam C interface type + @param ppRet inout returned interface pointer + @param x interface reference + @return true if successful, false otherwise +*/ template< class C > inline sal_Bool mapToUno( uno_Interface ** ppRet, const Reference< C > & x ) SAL_THROW( () ) { diff --git a/cppu/prj/build.lst b/cppu/prj/build.lst index 04d8eef6496d..03988afdd444 100644 --- a/cppu/prj/build.lst +++ b/cppu/prj/build.lst @@ -1,8 +1,7 @@ cu cppu : codemaker udkapi NULL cu cppu usr1 - all cu_mkout NULL cu cppu\source nmake - all cu_source NULL -cu cppu\source\cppu nmake - all cu_cppu NULL cu cppu\source\uno nmake - all cu_uno cu_source NULL cu cppu\source\threadpool nmake - all cu_thpool cu_source NULL cu cppu\source\typelib nmake - all cu_typelib NULL -cu cppu\util nmake - all cu_util cu_cppu cu_thpool cu_typelib cu_uno NULL +cu cppu\util nmake - all cu_util cu_thpool cu_typelib cu_uno NULL diff --git a/cppu/prj/d.lst b/cppu/prj/d.lst index e2ac98dec2ad..54f72d6df12e 100644 --- a/cppu/prj/d.lst +++ b/cppu/prj/d.lst @@ -36,6 +36,7 @@ mkdir: %_DEST%\inc%_EXT%\uno ..\inc\uno\threadpool.h %_DEST%\inc%_EXT%\uno\threadpool.h ..\inc\uno\current_context.h %_DEST%\inc%_EXT%\uno\current_context.h ..\inc\uno\current_context.hxx %_DEST%\inc%_EXT%\uno\current_context.hxx +..\inc\uno\cuno.h %_DEST%\inc%_EXT%\uno\cuno.h ..\%__SRC%\lib\icppu.lib %_DEST%\lib%_EXT%\icppu.lib ..\%__SRC%\bin\cppu* %_DEST%\bin%_EXT%\* diff --git a/cppu/source/cppu/makefile.mk b/cppu/source/cppu/makefile.mk deleted file mode 100644 index 79e2ee6f7557..000000000000 --- a/cppu/source/cppu/makefile.mk +++ /dev/null @@ -1,76 +0,0 @@ -#************************************************************************* -# -# $RCSfile: makefile.mk,v $ -# -# $Revision: 1.1.1.1 $ -# -# last change: $Author: hr $ $Date: 2000-09-18 15:25:52 $ -# -# 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): _______________________________________ -# -# -# -#************************************************************************* -PRJ=..$/.. - -PRJNAME= cppu -TARGET= cppu_cppu - -# --- Settings ----------------------------------------------------- - -.INCLUDE : svpre.mk -.INCLUDE : settings.mk -.INCLUDE : sv.mk - -# --- Files -------------------------------------------------------- - -.INCLUDE : ..$/..$/util$/target.pmk -.INCLUDE : target.mk diff --git a/cppu/source/typelib/makefile.mk b/cppu/source/typelib/makefile.mk index 4b10ad15e65b..867535ca0424 100644 --- a/cppu/source/typelib/makefile.mk +++ b/cppu/source/typelib/makefile.mk @@ -2,9 +2,9 @@ # # $RCSfile: makefile.mk,v $ # -# $Revision: 1.1.1.1 $ +# $Revision: 1.2 $ # -# last change: $Author: hr $ $Date: 2000-09-18 15:25:52 $ +# last change: $Author: dbo $ $Date: 2001-11-09 09:14:31 $ # # The Contents of this file are made available subject to the terms of # either of the following licenses @@ -74,8 +74,9 @@ TARGET=cppu_typelib # --- Files -------------------------------------------------------- SLOFILES= \ - $(SLO)$/typelib.obj \ - $(SLO)$/static_types.obj + $(SLO)$/typelib.obj \ + $(SLO)$/static_types.obj .INCLUDE : ..$/..$/util$/target.pmk .INCLUDE : target.mk + diff --git a/cppu/source/uno/lbenv.cxx b/cppu/source/uno/lbenv.cxx index 1e9fcae8ec80..a3abcd505c7f 100644 --- a/cppu/source/uno/lbenv.cxx +++ b/cppu/source/uno/lbenv.cxx @@ -2,9 +2,9 @@ * * $RCSfile: lbenv.cxx,v $ * - * $Revision: 1.21 $ + * $Revision: 1.22 $ * - * last change: $Author: jbu $ $Date: 2001-10-18 12:39:56 $ + * last change: $Author: dbo $ $Date: 2001-11-09 09:14:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -104,9 +104,6 @@ #ifndef _TYPELIB_TYPEDESCRIPTION_H_ #include <typelib/typedescription.h> #endif -#ifndef _UNO_LBNAMES_H_ -#include <uno/lbnames.h> -#endif #ifndef _UNO_DISPATCHER_H_ #include <uno/dispatcher.h> #endif diff --git a/cppu/source/uno/makefile.mk b/cppu/source/uno/makefile.mk index 16acb5c67235..d5ae2faf0f29 100644 --- a/cppu/source/uno/makefile.mk +++ b/cppu/source/uno/makefile.mk @@ -2,9 +2,9 @@ # # $RCSfile: makefile.mk,v $ # -# $Revision: 1.2 $ +# $Revision: 1.3 $ # -# last change: $Author: pluby $ $Date: 2000-12-14 07:33:56 $ +# last change: $Author: dbo $ $Date: 2001-11-09 09:14:31 $ # # The Contents of this file are made available subject to the terms of # either of the following licenses @@ -74,11 +74,11 @@ TARGET=cppu_uno # --- Files -------------------------------------------------------- SLOFILES= \ - $(SLO)$/data.obj \ - $(SLO)$/sequence.obj \ - $(SLO)$/any.obj \ - $(SLO)$/lbmap.obj \ - $(SLO)$/lbenv.obj + $(SLO)$/data.obj \ + $(SLO)$/sequence.obj \ + $(SLO)$/any.obj \ + $(SLO)$/lbmap.obj \ + $(SLO)$/lbenv.obj # --- Targets ------------------------------------------------------ diff --git a/cppu/util/makefile.mk b/cppu/util/makefile.mk index 2ff3abb50228..c497290ebe2f 100644 --- a/cppu/util/makefile.mk +++ b/cppu/util/makefile.mk @@ -2,9 +2,9 @@ # # $RCSfile: makefile.mk,v $ # -# $Revision: 1.2 $ +# $Revision: 1.3 $ # -# last change: $Author: jsc $ $Date: 2001-05-04 13:35:39 $ +# last change: $Author: dbo $ $Date: 2001-11-09 09:14:31 $ # # The Contents of this file are made available subject to the terms of # either of the following licenses @@ -70,51 +70,30 @@ NO_BSYMBOLIC=TRUE UNIXVERSIONNAMES=UDK # --- Settings ----------------------------------------------------- + .INCLUDE : settings.mk # --- Files -------------------------------------------------------- SHL1LIBS= \ - $(SLB)$/cppu_typelib.lib \ - $(SLB)$/cppu_uno.lib \ - $(SLB)$/cppu_threadpool.lib + $(SLB)$/cppu_typelib.lib \ + $(SLB)$/cppu_uno.lib \ + $(SLB)$/cppu_threadpool.lib -SHL1TARGET= $(TARGET) +SHL1TARGET=$(TARGET) -SHL1STDLIBS= $(SALLIB) +SHL1STDLIBS= \ + $(SALLIB) SHL1DEPN= -SHL1IMPLIB= i$(TARGET) -SHL1DEF= $(MISC)$/$(SHL1TARGET).def +SHL1IMPLIB=i$(TARGET) +SHL1DEF=$(MISC)$/$(SHL1TARGET).def -SHL1VERSIONMAP= $(TARGET).map +SHL1VERSIONMAP=$(TARGET).map -DEF1NAME= $(SHL1TARGET) -#DEF1EXPORTFILE= exports.dxp +DEF1NAME=$(SHL1TARGET) # --- Targets ------------------------------------------------------ .INCLUDE : target.mk -DOCPPFILES= \ - $(INC)$/typelib$/uik.h \ - $(INC)$/typelib$/typeclass.h \ - $(INC)$/typelib$/typedescription.h \ - $(INC)$/typelib$/typedescription.hxx \ - $(INC)$/uno$/any2.h \ - $(INC)$/uno$/sequence2.h \ - $(INC)$/uno$/data.h \ - $(INC)$/uno$/environment.h \ - $(INC)$/uno$/environment.hxx \ - $(INC)$/uno$/mapping.h \ - $(INC)$/uno$/mapping.hxx \ - $(INC)$/uno$/dispatcher.h \ - $(INC)$/uno$/threadpool.h \ - $(INC)$/com$/sun$/star$/uno$/genfunc.h \ - $(INC)$/com$/sun$/star$/uno$/Reference.h\ - $(INC)$/com$/sun$/star$/uno$/Type.h \ - $(INC)$/com$/sun$/star$/uno$/Any.h \ - $(INC)$/com$/sun$/star$/uno$/Sequence.h - -docpp: $(DOCPPFILES) - +doc++ -H -m -f -u -d $(OUT)$/doc$/$(PRJNAME) $(DOCPPFILES) |