# libplp Globals

Annotated List
Files
Globals
Hierarchy
Index

### Enum.h

- template <typename E> inline std::ostream& operator << (std::ostream& out, const Enum<E> &e)

### plpdirent.h

- inline bool operator< (const PlpUID &u1, const PlpUID &u2)

### plpintl.h

- extern inline char * stpcpy (char *dest, const char *src)
- static inline const char * X_ (const char *t)
- static inline const char * _ (const char *t)
- static inline const char * X_ (const char *t)
- static inline const char * _ (const char *t)
- static inline const char * N_ (const char *t)

### psibitmap.h

- typedef int (*getPixelFunction_t) (int x, int y)
- extern void encodeBitmap (int width, int height, getPixelFunction_t getPixel, bool rle, bufferStore &out)
- extern bool decodeBitmap (const unsigned char *p, int &width, int &height, bufferStore &out)

### psitime.h

- typedef struct psi_timeval_t
- typedef struct psi_timezone_t

### rfsv.h

- typedef std::deque<class PlpDirent> PlpDir
- typedef int (*cpCallback_t) (void *, u_int32_t)

### rpcs.h

- typedef std::vector<PsiProcess> processList

### sistypes.h

- enum SisRC { SIS_OK = 0, SIS_TRUNCATED, SIS_TRUNCATEDDATA, SIS_CORRUPTED, SIS_FAILED, SIS_ABORTED, SIS_DIFFERENT_APP, SIS_VER_EARLIER, SIS_SAME_OR_LATER, SIS_OTHER_VARIANT }
- extern uint16_t read16 (uint8_t* p)
- extern uint32_t read32 (uint8_t* p)
- extern void write16 (uint8_t* p, int val)
- extern void createCRCTable ()
- extern uint16_t updateCrc (uint16_t crc, uint8_t value)

## Global member Documentation

template <typename E> inline std::ostream& operator << (std::ostream& out, const Enum<E> &e)

### operator <<

`#include <Enum.h>`

Writes enumeration's string representation.

inline bool operator< (const PlpUID &u1, const PlpUID &u2)

### operator<

`#include <plpdirent.h>`

extern inline char * stpcpy (char *dest, const char *src)

### stpcpy

`#include <plpintl.h>`

inline const char * X_ (const char *t)

### X_

[static]

`#include <plpintl.h>`

inline const char * _ (const char *t)

### _

[static]

`#include <plpintl.h>`

inline const char * X_ (const char *t)

### X_

[static]

`#include <plpintl.h>`

inline const char * _ (const char *t)

### _

[static]

`#include <plpintl.h>`

inline const char * N_ (const char *t)

### N_

[static]

`#include <plpintl.h>`

typedef int (*getPixelFunction_t) (int x, int y)

### (*getPixelFunction_t)

`#include <psibitmap.h>`

This function is used by encodeBitmap for retrieving image data. It must return a gray value between 0 and 255 where 0 is black and 255 is white.

Parameters:

x | The x coordinate of the pixel to get (0 = left)
y | The y coordinate of the pixel to get (0 = top)

extern void encodeBitmap (int width, int height, getPixelFunction_t getPixel, bool rle, bufferStore &out)

### encodeBitmap

`#include <psibitmap.h>`

Convert an image into a bitmap in Psion format.

Parameters:

width | The width of the image to convert.
height | The height of the image to convert.
getPixel | Pointer to a function for retrieving pixel values.
rle | Flag: Perform RLE compression (currently ignored).
out | Output buffer; gets filled with the Psion representation of the converted image.

extern bool decodeBitmap (const unsigned char *p, int &width, int &height, bufferStore &out)

### decodeBitmap

`#include <psibitmap.h>`

Convert a Psion bitmap to a 8bit/pixel grayscale image.

Parameters:

p | Pointer to an input buffer which contains the Psion-formatted bitmap to convert. Must start with a Psion bitmap header.
width | On return, the image width in pixels is returned here.
height | On return, the image height in pixels is returned here.
out | Buffer which gets filled with the raw image data. Each pixel is represented by a byte. The image data is organized in height scanlines of width bytes, starting with the topmost scanline.

Returns: true on success, false if input data is inconsistent.

typedef struct psi_timeval_t

### psi_timeval_t

`#include <psitime.h>`

Holds a Psion time value. Psion time values are 64 bit integers describing the time since 01.01.0001 in microseconds.

typedef struct psi_timezone_t

### psi_timezone_t

`#include <psitime.h>`

holds a Psion time zone description.

typedef std::deque<class PlpDirent> PlpDir

### PlpDir

`#include <rfsv.h>`

The socket to be used for connecting to the ncpd daemon.

typedef int (*cpCallback_t) (void *, u_int32_t)

### (*cpCallback_t)

`#include <rfsv.h>`

Defines the callback procedure for progress indication of copy operations.

typedef std::vector<PsiProcess> processList

### processList

`#include <rpcs.h>`

enum SisRC { SIS_OK = 0, SIS_TRUNCATED, SIS_TRUNCATEDDATA, SIS_CORRUPTED, SIS_FAILED, SIS_ABORTED, SIS_DIFFERENT_APP, SIS_VER_EARLIER, SIS_SAME_OR_LATER, SIS_OTHER_VARIANT }

### SisRC

`#include <sistypes.h>`

Return Codes.

extern uint16_t read16 (uint8_t* p)

### read16

`#include <sistypes.h>`

extern uint32_t read32 (uint8_t* p)

### read32

`#include <sistypes.h>`

extern void write16 (uint8_t* p, int val)

### write16

`#include <sistypes.h>`

extern void createCRCTable ()

### createCRCTable

`#include <sistypes.h>`

extern uint16_t updateCrc (uint16_t crc, uint8_t value)

### updateCrc

`#include <sistypes.h>`

Generated by: rrt on drom on Mon Nov 26 16:06:15 2007, using kdoc 2.0a54.