Cross Platform Functions. More...

#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <stddef.h>

Include dependency graph for pwpPlatform.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	sysEOF EOF
	End-of-file value. More...

Typedefs
typedef fpos_t	sysFILEPOS
	File position data type. More...

Enumerations
enum	sysFILEMODE { pwpRead = pwpRead_, pwpWrite = pwpWrite_, pwpAppend = pwpAppend_, pwpRWExists = (pwpRead_ \| pwpPlus_), pwpRWTruncate = (pwpWrite_ \| pwpPlus_), pwpReadAppend = (pwpAppend_ \| pwpPlus_), pwpBinary = 0x10, pwpFormatted = 0x20, pwpUnformatted = 0x40, pwpAscii = 0x80 }
	Bit flags used for pwpFileOpen(mode) More...

Functions
int	pwpCwdPop (void)
	Restore the current directory. More...

int	pwpCwdPush (const char *dir)
	Change the current directory using a stack. More...

int	pwpFileClose (FILE *fp)
	Closes a file opened with pwpFileOpen(). More...

int	pwpFileDelete (const char *filename)
	Delete a file. More...

int	pwpFileEof (FILE *fp)
	Queries end-of-file status. More...

int	pwpFileFlush (FILE *fp)
	Flush a file to disk. More...

int	pwpFileGetpos (FILE fp, sysFILEPOS pos)
	Query the current file position. More...

int	pwpFileGetSize (FILE fp, size_t size)
	Get the file's size in bytes. More...

int	pwpFilenameGetSize (const char filename, size_t size)
	Get the file's size in bytes. More...

FILE *	pwpFileOpen (const char *filename, int mode)
	Opens a file for I/O. More...

size_t	pwpFileRead (void buf, size_t size, size_t count, FILE fp)
	Read an collection of data items from a file. More...

void	pwpFileRewind (FILE *fp)
	Reset position to the beginning of the file. More...

int	pwpFileSetpos (FILE fp, const sysFILEPOS pos)
	Set the current file position. More...

size_t	pwpFileWrite (const void buf, size_t size, size_t count, FILE fp)
	Write an collection of data items to a file. More...

size_t	pwpFileWriteStr (const char str, FILE fp)
	Write a null-terminated string to a file. More...

int	pwpSetCurDir (const char *dir)
	Change the current directory. More...

Detailed Description

Cross Platform Functions.

Certain operations and data-types required by a plugin are platform dependent. To simplify access to these operations, the following set of cross-platform functions have been implemented in the SDK.

If a plugin uses these functions and data-types, it should compile and run on all Pointwise-supported platforms.

Definition in file pwpPlatform.h.

Macro Definition Documentation

◆ sysEOF

#define sysEOF EOF

End-of-file value.

Definition at line 50 of file pwpPlatform.h.

Typedef Documentation

◆ sysFILEPOS

sysFILEPOS

File position data type.

Definition at line 51 of file pwpPlatform.h.

Enumeration Type Documentation

◆ sysFILEMODE

enum sysFILEMODE

Bit flags used for pwpFileOpen(mode)

To compose a full mode value, combine one mode flag with one format flag.

Enumerator
pwpRead	mode: Read access
pwpWrite	mode: Write access
pwpAppend	mode: Append access
pwpRWExists	mode: Read/Write access. File must exist.
pwpRWTruncate	mode: Read/Write access. File will be truncated.
pwpReadAppend	mode: Read with Write append access.
pwpBinary	format: Generic binary.
pwpFormatted	format: Formatted FORTRAN (ASCII).
pwpUnformatted	format: Unformatted FORTRAN (binary records).
pwpAscii	format: Generic ASCII.