desktop/source/pagein/file_image.h

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: file_image.h,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_FILE_IMAGE_H
  32 #define INCLUDED_FILE_IMAGE_H
  33
  34 #ifndef INCLUDED_STDDEF_H
  35 #include <stddef.h>
  36 #define INCLUDED_STDDEF_H
  37 #endif
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 /** file_image.
  44  */
  45 struct file_image_st
  46 {
  47     void * m_base;
  48     size_t m_size;
  49 };
  50
  51 typedef struct file_image_st file_image;
  52
  53 #define FILE_IMAGE_INITIALIZER { 0, 0 }
  54
  55
  56 /** file_image_open.
  57  */
  58 int file_image_open (
  59     file_image * image,
  60     const char * filename);
  61
  62
  63 /** file_image_pagein.
  64  */
  65 int file_image_pagein (
  66     file_image * image);
  67
  68
  69 /** file_image_close.
  70  */
  71 int file_image_close (
  72     file_image * image);
  73
  74
  75 /** Epilog.
  76  */
  77 #ifdef __cplusplus
  78 }
  79 #endif
  80
  81 #endif /* INCLUDED_ODEP_IMAGE_H */