include/store/store.h

   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
  20 #ifndef INCLUDED_STORE_STORE_H
  21 #define INCLUDED_STORE_STORE_H
  22
  23 #include <store/types.h>
  24 #include <store/storedllapi.h>
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 /** Handle opaque type.
  31  */
  32 typedef void* storeHandle;
  33
  34
  35 /** Acquire a Handle.
  36     @param  Handle [in] the Handle.
  37     @return store_E_None upon success
  38  */
  39 STORE_DLLPUBLIC storeError SAL_CALL store_acquireHandle (
  40     storeHandle Handle
  41 ) SAL_THROW_EXTERN_C();
  42
  43
  44 /** Release a Handle.
  45     @param  Handle [in] the Handle.
  46     @return store_E_None          upon success,
  47             store_E_InvalidHandle otherwise.
  48  */
  49 STORE_DLLPUBLIC storeError SAL_CALL store_releaseHandle (
  50     storeHandle Handle
  51 ) SAL_THROW_EXTERN_C();
  52
  53
  54
  55 /** File Handle opaque type.
  56  */
  57 typedef void* storeFileHandle;
  58
  59
  60 /** Open a temporary file in memory.
  61     @param  nPageSize [in] the creation page size,
  62             integer multiple of minimum page size.
  63     @param  phFile [out] the File Handle.
  64     @return store_E_None upon success
  65  */
  66 STORE_DLLPUBLIC storeError SAL_CALL store_createMemoryFile (
  67     sal_uInt16       nPageSize,
  68     storeFileHandle *phFile
  69 ) SAL_THROW_EXTERN_C();
  70
  71
  72 /** Open a file.
  73     @param  pFilename [in] the filename as URL or system path.
  74     @param  eAccessMode [in] the access mode.
  75             store_AccessCreate     truncate existing and create,
  76             store_AccessReadCreate create not existing,
  77             store_AccessReadWrite  write existing,
  78             store_AccessReadOnly   never modifies.
  79     @param  nPageSize [in] the creation page size,
  80             integer multiple of minimum page size.
  81     @param  phFile [out] the File Handle.
  82     @return store_E_None upon success
  83  */
  84 STORE_DLLPUBLIC storeError SAL_CALL store_openFile (
  85     rtl_uString     *pFilename,
  86     storeAccessMode  eAccessMode,
  87     sal_uInt16       nPageSize,
  88     storeFileHandle *phFile
  89 ) SAL_THROW_EXTERN_C();
  90
  91
  92 /** Close a file.
  93     @param  hFile [in] the File Handle.
  94     @return store_E_None upon     success,
  95             store_E_InvalidHandle otherwise.
  96  */
  97 STORE_DLLPUBLIC storeError SAL_CALL store_closeFile (
  98     storeFileHandle hFile
  99 ) SAL_THROW_EXTERN_C();
 100
 101
 102 /** Flush a file.
 103     @param  hFile [in] the File Handle.
 104     @return store_E_None upon success
 105  */
 106 STORE_DLLPUBLIC storeError SAL_CALL store_flushFile (
 107     storeFileHandle hFile
 108 ) SAL_THROW_EXTERN_C();
 109
 110
 111 /** Get the number of referers to a file.
 112     @param  hFile [in] the File Handle.
 113     @param  pnRefCount [out] number of open directories and streams.
 114     @return store_E_None upon success
 115  */
 116 STORE_DLLPUBLIC storeError SAL_CALL store_getFileRefererCount (
 117     storeFileHandle  hFile,
 118     sal_uInt32      *pnRefCount
 119 ) SAL_THROW_EXTERN_C();
 120
 121
 122 /** Get the size of a file.
 123     @param  hFile [in] the File Handle.
 124     @param  pnSize [out] the file size in bytes.
 125     @return store_E_None upon success
 126  */
 127 STORE_DLLPUBLIC storeError SAL_CALL store_getFileSize (
 128     storeFileHandle  hFile,
 129     sal_uInt32      *pnSize
 130 ) SAL_THROW_EXTERN_C();
 131
 132
 133 /** Recover and Compact a file into another file.
 134     @see store_openFile()
 135
 136     @param  pSrcFilename [in] opened with store_AccessReadOnly.
 137     @param  pDstFilename [in] created with store_AccessCreate.
 138     @return store_E_None upon success
 139  */
 140 STORE_DLLPUBLIC storeError SAL_CALL store_rebuildFile (
 141     rtl_uString *pSrcFilename,
 142     rtl_uString *pDstFilename
 143 ) SAL_THROW_EXTERN_C();
 144
 145
 146
 147 /** Directory Handle opaque type.
 148  */
 149 typedef void* storeDirectoryHandle;
 150
 151
 152 /** Open a directory.
 153     @see store_openFile()
 154
 155     @param  hFile [in] the File Handle.
 156     @param  pPath [in] the directory path.
 157     @param  pName [in] the directory name.
 158     @param  eAccessMode [in] the access mode.
 159     @param  phDirectory [out] the Directory Handle.
 160     @return store_E_None upon success
 161  */
 162 STORE_DLLPUBLIC storeError SAL_CALL store_openDirectory (
 163     storeFileHandle       hFile,
 164     rtl_uString          *pPath,
 165     rtl_uString          *pName,
 166     storeAccessMode       eAccessMode,
 167     storeDirectoryHandle *phDirectory
 168 ) SAL_THROW_EXTERN_C();
 169
 170
 171 /** Close a directory.
 172     @param  hDirectory [in] the Directory Handle.
 173     @return store_E_None          upon success,
 174             store_E_InvalidHandle otherwise.
 175  */
 176 STORE_DLLPUBLIC storeError SAL_CALL store_closeDirectory (
 177     storeDirectoryHandle hDirectory
 178 ) SAL_THROW_EXTERN_C();
 179
 180
 181 /** Find first directory entry.
 182     @param  hDirectory [in] the Directory Handle.
 183     @param  pFindData [out] the Find Data structure.
 184     @return store_E_None       upon success,
 185             store_E_NoMoreFile upon end of iteration.
 186  */
 187 STORE_DLLPUBLIC storeError SAL_CALL store_findFirst (
 188     storeDirectoryHandle  hDirectory,
 189     storeFindData        *pFindData
 190 ) SAL_THROW_EXTERN_C();
 191
 192
 193 /** Find next directory entry.
 194     @param  hDirectory [in] the Directory Handle.
 195     @param  pFindData [out] the Find Data structure.
 196     @return store_E_None       upon success,
 197             store_E_NoMoreFile upon end of iteration.
 198  */
 199 STORE_DLLPUBLIC storeError SAL_CALL store_findNext (
 200     storeDirectoryHandle  hDirectory,
 201     storeFindData        *pFindData
 202 ) SAL_THROW_EXTERN_C();
 203
 204
 205
 206 /** Stream Handle opaque type.
 207  */
 208 typedef void* storeStreamHandle;
 209
 210
 211 /** Open a stream.
 212     @see store_openFile()
 213
 214     @param  hFile [in] the File Handle.
 215     @param  pPath [in] the stream path.
 216     @param  pName [in] the stream name.
 217     @param  eMode [in] the access mode.
 218     @param  phStrm [out] the Stream Handle.
 219     @return store_E_None upon success
 220  */
 221 STORE_DLLPUBLIC storeError SAL_CALL store_openStream (
 222     storeFileHandle    hFile,
 223     rtl_uString       *pPath,
 224     rtl_uString       *pName,
 225     storeAccessMode    eMode,
 226     storeStreamHandle *phStrm
 227 ) SAL_THROW_EXTERN_C();
 228
 229
 230 /** Close a stream.
 231     @param  hStrm [in] the Stream Handle.
 232     @return store_E_None          upon success,
 233             store_E_InvalidHandle otherwise.
 234  */
 235 STORE_DLLPUBLIC storeError SAL_CALL store_closeStream (
 236     storeStreamHandle hStrm
 237 ) SAL_THROW_EXTERN_C();
 238
 239
 240 /** Read from a stream.
 241     @param  hStrm [in] the Stream Handle.
 242     @param  nOffset [in] the offset of the first byte to read.
 243     @param  pBuffer [out] the buffer.
 244     @param  nBytes [in] the number of bytes to read.
 245     @param  pnDone [out] the number of bytes actually read.
 246     @return store_E_None upon success
 247  */
 248 STORE_DLLPUBLIC storeError SAL_CALL store_readStream (
 249     storeStreamHandle  hStrm,
 250     sal_uInt32         nOffset,
 251     void              *pBuffer,
 252     sal_uInt32         nBytes,
 253     sal_uInt32        *pnDone
 254 ) SAL_THROW_EXTERN_C();
 255
 256
 257 /** Write to a stream.
 258     @param  hStrm [in] the Stream Handle.
 259     @param  nOffset [in] the offset of the first byte to write.
 260     @param  pBuffer [in] the buffer.
 261     @param  nBytes [in] the number of bytes to write.
 262     @param  pnDone [out] the number of bytes actually written.
 263     @return store_E_None upon success
 264  */
 265 STORE_DLLPUBLIC storeError SAL_CALL store_writeStream (
 266     storeStreamHandle  hStrm,
 267     sal_uInt32         nOffset,
 268     const void        *pBuffer,
 269     sal_uInt32         nBytes,
 270     sal_uInt32        *pnDone
 271 ) SAL_THROW_EXTERN_C();
 272
 273
 274 /** Flush a stream.
 275     @param  hStrm [in] the Stream Handle.
 276     @return store_E_None upon success
 277  */
 278 STORE_DLLPUBLIC storeError SAL_CALL store_flushStream (
 279     storeStreamHandle hStrm
 280 ) SAL_THROW_EXTERN_C();
 281
 282
 283 /** Get the size of a stream.
 284     @param  hStrm [in] the Stream Handle.
 285     @param  pnSize [out] the stream size in bytes.
 286     @return store_E_None upon success
 287  */
 288 STORE_DLLPUBLIC storeError SAL_CALL store_getStreamSize (
 289     storeStreamHandle  hStrm,
 290     sal_uInt32        *pnSize
 291 ) SAL_THROW_EXTERN_C();
 292
 293
 294 /** Set the size of a stream.
 295     @param  hStrm [in] the Stream Handle.
 296     @param  nSize [in] the new stream size in bytes.
 297     @return store_E_None upon success
 298  */
 299 STORE_DLLPUBLIC storeError SAL_CALL store_setStreamSize (
 300     storeStreamHandle hStrm,
 301     sal_uInt32        nSize
 302 ) SAL_THROW_EXTERN_C();
 303
 304
 305
 306 /** Set attributes of a file entry.
 307     @param  hFile [in] the File Handle.
 308     @param  pPath [in] the entry path.
 309     @param  pName [in] the entry name.
 310     @param  nMask1 [in] the attributes to be cleared.
 311     @param  nMask2 [in] the attributes to be set.
 312     @param  pnAttrib [out] the resulting attributes, may be NULL.
 313     @return store_E_None upon success
 314  */
 315 STORE_DLLPUBLIC storeError SAL_CALL store_attrib (
 316     storeFileHandle hFile,
 317     rtl_uString    *pPath,
 318     rtl_uString    *pName,
 319     sal_uInt32      nMask1,
 320     sal_uInt32      nMask2,
 321     sal_uInt32     *pnAttrib
 322 ) SAL_THROW_EXTERN_C();
 323
 324
 325 /** Insert a file entry as 'hard link' to another file entry.
 326     @pre  Source must not exist, Destination must exist.
 327     @post Source has attribute STORE_ATTRIB_ISLINK.
 328     @see      store_attrib()
 329
 330     @param  hFile [in] the File Handle
 331     @param  pSrcPath [in] the Source path
 332     @param  pSrcName [in] the Source name
 333     @param  pDstPath [in] the Destination path
 334     @param  pDstName [in] the Destination name
 335     @return store_E_None upon success
 336  */
 337 STORE_DLLPUBLIC storeError SAL_CALL store_link (
 338     storeFileHandle hFile,
 339     rtl_uString *pSrcPath, rtl_uString *pSrcName,
 340     rtl_uString *pDstPath, rtl_uString *pDstName
 341 ) SAL_THROW_EXTERN_C();
 342
 343
 344 /** Insert a file entry as 'symbolic link' to another file entry.
 345     @pre  Source must not exist
 346     @post Source has attribute STORE_ATTRIB_ISLINK.
 347     @see      store_attrib()
 348
 349     @param  hFile [in] the File Handle
 350     @param  pSrcPath [in] the Source path
 351     @param  pSrcName [in] the Source name
 352     @param  pDstPath [in] the Destination path
 353     @param  pDstName [in] the Destination name
 354     @return store_E_None upon success
 355  */
 356 STORE_DLLPUBLIC storeError SAL_CALL store_symlink (
 357     storeFileHandle hFile,
 358     rtl_uString *pSrcPath, rtl_uString *pSrcName,
 359     rtl_uString *pDstPath, rtl_uString *pDstName
 360 ) SAL_THROW_EXTERN_C();
 361
 362
 363 /** Rename a file entry.
 364     @param  hFile [in] the File Handle
 365     @param  pSrcPath [in] the Source path
 366     @param  pSrcName [in] the Source name
 367     @param  pDstPath [in] the Destination path
 368     @param  pDstName [in] the Destination name
 369     @return store_E_None upon success
 370  */
 371 STORE_DLLPUBLIC storeError SAL_CALL store_rename (
 372     storeFileHandle hFile,
 373     rtl_uString *pSrcPath, rtl_uString *pSrcName,
 374     rtl_uString *pDstPath, rtl_uString *pDstName
 375 ) SAL_THROW_EXTERN_C();
 376
 377
 378 /** Remove a file entry.
 379     @param  hFile [in] the File Handle
 380     @param  pPath [in] the entry path
 381     @param  pName [in] the entry name
 382     @return store_E_None upon success
 383  */
 384 STORE_DLLPUBLIC storeError SAL_CALL store_remove (
 385     storeFileHandle hFile,
 386     rtl_uString    *pPath,
 387     rtl_uString    *pName
 388 ) SAL_THROW_EXTERN_C();
 389
 390 /*========================================================================
 391  *
 392  * The End.
 393  *
 394  *======================================================================*/
 395
 396 #ifdef __cplusplus
 397 }
 398 #endif
 399
 400 #endif // INCLUDED_STORE_STORE_H
 401
 402
 403
 404
 405 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */