LibreOffice
LibreOffice 6.2 SDK C/C++ API Reference
byteseq.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 #ifndef INCLUDED_RTL_BYTESEQ_H
20 #define INCLUDED_RTL_BYTESEQ_H
21 
22 #include "sal/config.h"
23 
24 #include "rtl/alloc.h"
25 #include "sal/saldllapi.h"
26 #include "sal/types.h"
27 
28 #ifdef __cplusplus
29 extern "C"
30 {
31 #endif
32 
39  sal_Sequence ** ppSequence )
41 
48  sal_Sequence ** ppSequence, sal_Int32 nSize )
50 
56  sal_Sequence *pSequence )
58 
64  sal_Sequence *pSequence )
66 
74  sal_Sequence **ppSequence , sal_Int32 nLength )
76 
84  sal_Sequence **ppSequence , sal_Int32 nLength )
86 
95  sal_Sequence **ppSequence, const sal_Int8 *pData , sal_Int32 nLength )
97 
105  sal_Sequence **ppSequence , sal_Sequence *pSequence )
107 
113  sal_Sequence *pSequence1 , sal_Sequence *pSequence2 )
115 
123  sal_Sequence *pSequence )
125 
131 SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_byte_sequence_getLength(
132  sal_Sequence *pSequence )
134 
135 #ifdef __cplusplus
136 }
137 namespace rtl
138 {
139 
141 {
145 };
146 
148 {
153 #if defined _MSC_VER
154  int(0xcafebabe)
155 #else
156  0xcafebabe
157 #endif
158 };
159 
166 {
169  sal_Sequence * _pSequence;
170 
171 public:
173  // these are here to force memory de/allocation to sal lib.
174  static void * SAL_CALL operator new ( size_t nSize )
175  { return ::rtl_allocateMemory( nSize ); }
176  static void SAL_CALL operator delete ( void * pMem )
177  { ::rtl_freeMemory( pMem ); }
178  static void * SAL_CALL operator new ( size_t, void * pMem )
179  { return pMem; }
180  static void SAL_CALL operator delete ( void *, void * )
181  {}
183 
186  inline ByteSequence();
191  inline ByteSequence( const ByteSequence & rSeq );
192 #if defined LIBO_INTERNAL_ONLY
193  inline ByteSequence( ByteSequence && rSeq );
194 #endif
195 
199  inline ByteSequence( sal_Sequence *pSequence );
205  inline ByteSequence( const sal_Int8 * pElements, sal_Int32 len );
210  inline ByteSequence( sal_Int32 len );
217  inline ByteSequence( sal_Int32 len , enum __ByteSequence_NoDefault nodefault );
227  inline ByteSequence( sal_Sequence *pSequence , enum __ByteSequence_NoAcquire noacquire );
230  inline ~ByteSequence();
231 
237  inline ByteSequence & SAL_CALL operator = ( const ByteSequence & rSeq );
238 #if defined LIBO_INTERNAL_ONLY
239  inline ByteSequence & SAL_CALL operator = ( ByteSequence && rSeq );
240 #endif
241 
246  sal_Int32 SAL_CALL getLength() const
247  { return _pSequence->nElements; }
248 
254  const sal_Int8 * SAL_CALL getConstArray() const
255  { return reinterpret_cast<sal_Int8 *>(_pSequence->elements); }
263  inline sal_Int8 * SAL_CALL getArray();
264 
277  inline sal_Int8 & SAL_CALL operator [] ( sal_Int32 nIndex );
278 
285  const sal_Int8 & SAL_CALL operator [] ( sal_Int32 nIndex ) const
286  { return getConstArray()[ nIndex ]; }
287 
293  inline bool SAL_CALL operator == ( const ByteSequence & rSeq ) const;
299  inline bool SAL_CALL operator != ( const ByteSequence & rSeq ) const;
300 
307  inline void SAL_CALL realloc( sal_Int32 nSize );
308 
313  sal_Sequence * SAL_CALL getHandle() const
314  { return _pSequence; }
319  sal_Sequence * SAL_CALL get() const
320  { return _pSequence; }
321 };
322 
323 }
324 #endif
325 #endif
326 
327 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
SAL_DLLPUBLIC void rtl_byte_sequence_assign(sal_Sequence **ppSequence, sal_Sequence *pSequence) SAL_THROW_EXTERN_C()
Assigns the byte sequence pSequence to *ppSequence.
SAL_DLLPUBLIC void rtl_byte_sequence_acquire(sal_Sequence *pSequence) SAL_THROW_EXTERN_C()
Acquires the byte sequence.
#define SAL_DLLPUBLIC
Definition: saldllapi.h:30
__ByteSequence_NoDefault
Definition: byteseq.h:140
#define SAL_WARN_UNUSED
Annotate classes where a compiler should warn if an instance is unused.
Definition: types.h:602
SAL_DLLPUBLIC void rtl_byte_sequence_release(sal_Sequence *pSequence) SAL_THROW_EXTERN_C()
Releases the byte sequence.
SAL_DLLPUBLIC void rtl_freeMemory(void *Ptr) SAL_THROW_EXTERN_C()
Free memory.
SAL_DLLPUBLIC void rtl_byte_sequence_construct(sal_Sequence **ppSequence, sal_Int32 nLength) SAL_THROW_EXTERN_C()
Constructs a bytes sequence with length nLength.
unsigned char sal_Bool
Definition: types.h:38
SAL_DLLPUBLIC void rtl_byte_sequence_reference2One(sal_Sequence **ppSequence) SAL_THROW_EXTERN_C()
Assures that the reference count of the given byte sequence is one.
bool operator!=(const Any &rAny, const C &value)
Template unequality operator: compares set value of left side any to right side value.
Definition: Any.hxx:645
signed char sal_Int8
Definition: types.h:43
This enum value can be used to create a bytesequence with uninitialized data.
Definition: byteseq.h:144
bool operator==(const TTimeValue &rTimeA, const TTimeValue &rTimeB)
Definition: timer.hxx:110
SAL_DLLPUBLIC sal_Bool rtl_byte_sequence_equals(sal_Sequence *pSequence1, sal_Sequence *pSequence2) SAL_THROW_EXTERN_C()
Compares two byte sequences.
Definition: bootstrap.hxx:29
This is the binary specification of a SAL sequence.
Definition: types.h:321
sal_Int32 getLength() const
Gets the length of sequence.
Definition: byteseq.h:246
C++ class representing a SAL byte sequence.
Definition: byteseq.h:165
SAL_DLLPUBLIC void rtl_byte_sequence_realloc(sal_Sequence **ppSequence, sal_Int32 nSize) SAL_THROW_EXTERN_C()
Reallocates length of byte sequence.
SAL_DLLPUBLIC void rtl_byte_sequence_constructNoDefault(sal_Sequence **ppSequence, sal_Int32 nLength) SAL_THROW_EXTERN_C()
Constructs a bytes sequence with length nLength.
This enum value can be used to create a bytesequence from a C-Handle without acquiring the handle...
Definition: byteseq.h:152
SAL_DLLPUBLIC void * rtl_allocateMemory(sal_Size Bytes) SAL_THROW_EXTERN_C()
Allocate memory.
const sal_Int8 * getConstArray() const
Gets a pointer to byte array for READING.
Definition: byteseq.h:254
#define SAL_THROW_EXTERN_C()
Nothrow specification for C functions.
Definition: types.h:346
SAL_DLLPUBLIC void rtl_byte_sequence_constructFromArray(sal_Sequence **ppSequence, const sal_Int8 *pData, sal_Int32 nLength) SAL_THROW_EXTERN_C()
Constructs a byte sequence with length nLength and copies nLength bytes from pData.
__ByteSequence_NoAcquire
Definition: byteseq.h:147
SAL_DLLPUBLIC sal_Int32 rtl_byte_sequence_getLength(sal_Sequence *pSequence) SAL_THROW_EXTERN_C()
Returns the length of the sequence.
sal_Sequence * getHandle() const
Returns the UNnacquired C handle of the sequence.
Definition: byteseq.h:313
SAL_DLLPUBLIC const sal_Int8 * rtl_byte_sequence_getConstArray(sal_Sequence *pSequence) SAL_THROW_EXTERN_C()
Returns the data array pointer of the sequence.