ccextractor/windows/libs/include/ptra.h
2016-12-23 18:01:12 +03:00

96 lines
3.6 KiB
C

/*====================================================================*
- Copyright (C) 2001 Leptonica. All rights reserved.
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions
- are met:
- 1. Redistributions of source code must retain the above copyright
- notice, this list of conditions and the following disclaimer.
- 2. Redistributions in binary form must reproduce the above
- copyright notice, this list of conditions and the following
- disclaimer in the documentation and/or other materials
- provided with the distribution.
-
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANY
- CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
- EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
- PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
- OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*====================================================================*/
#ifndef LEPTONICA_PTRA_H
#define LEPTONICA_PTRA_H
/*!
* \file ptra.h
*
* <pre>
* Contains the following structs:
* struct L_Ptra
* struct L_Ptraa
*
* Contains definitions for:
* L_Ptra compaction flags for removal
* L_Ptra shifting flags for insert
* L_Ptraa accessor flags
* </pre>
*/
/*------------------------------------------------------------------------*
* Generic Ptr Array Structs *
*------------------------------------------------------------------------*/
/*! Generic pointer array */
struct L_Ptra
{
l_int32 nalloc; /*!< size of allocated ptr array */
l_int32 imax; /*!< greatest valid index */
l_int32 nactual; /*!< actual number of stored elements */
void **array; /*!< ptr array */
};
typedef struct L_Ptra L_PTRA;
/*! Array of generic pointer arrays */
struct L_Ptraa
{
l_int32 nalloc; /*!< size of allocated ptr array */
struct L_Ptra **ptra; /*!< array of ptra */
};
typedef struct L_Ptraa L_PTRAA;
/*------------------------------------------------------------------------*
* Array flags *
*------------------------------------------------------------------------*/
/*! Flags for removal from L_Ptra */
enum {
L_NO_COMPACTION = 1, /*!< null the pointer only */
L_COMPACTION = 2 /*!< compact the array */
};
/*! Flags for insertion into L_Ptra */
enum {
L_AUTO_DOWNSHIFT = 0, /*!< choose based on number of holes */
L_MIN_DOWNSHIFT = 1, /*!< downshifts min # of ptrs below insert */
L_FULL_DOWNSHIFT = 2 /*!< downshifts all ptrs below insert */
};
/*! Accessor flags for L_Ptraa */
enum {
L_HANDLE_ONLY = 0, /*!< ptr to L_Ptra; caller can inspect only */
L_REMOVE = 1 /*!< caller owns; destroy or save in L_Ptraa */
};
#endif /* LEPTONICA_PTRA_H */