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