---

<cahute/file.h> – File related utilities for Cahute

Macro definitions

CAHUTE_FILE_TYPE_* are constants representing the type of an opened file.

CAHUTE_FILE_TYPE_ADDIN_CG

fx-CG add-in; see fx-CG add-ins for more information.

CAHUTE_FILE_TYPE_ADDIN_FX

fx add-in; see fx-9860G add-ins for more information.

CAHUTE_FILE_TYPE_CASIOLINK

CASIOLINK archive, that can be used as a main memory archive; see CASIOLINK archives for more information.

CAHUTE_FILE_TYPE_EACT_FX

fx e-Activity; see e-Activity files for more information.

CAHUTE_FILE_TYPE_FKEY_FX

fx function keys file; see fx-9860G f-key files for more information.

CAHUTE_FILE_TYPE_FKEY_CG

fx-CG function keys file; see fx-CG f-key files for more information.

CAHUTE_FILE_TYPE_LANG_CG

fx-CG language file; see fx-CG language files for more information.

CAHUTE_FILE_TYPE_LANG_FX

fx language file; see fx-9860G language files for more information.

CAHUTE_FILE_TYPE_MAINMEM

fx main memory archive; see Main memory archives for more information.

CAHUTE_FILE_TYPE_PICTURE_CG

fx-CG picture; see fx-CG picture for more information.

CAHUTE_FILE_TYPE_PICTURE_CP

fx-CP picture; see fx-CP picture for more information.

Type definitions

struct cahute_file

Opened file for reading or writing.

This type is opaque, and such resources must be created using cahute_open_file().

Function declarations

int cahute_open_file(cahute_file **filep, void const *path, int path_type)

Open a file from a path, in order to read it.

Parameters:

• filep – Pointer to the file object to create.

• path – Path to the file to open, with the file type.

• path_type – Type of the path to the file to open.

Returns:

Error, or 0 if the operation was successful.

int cahute_create_file(cahute_file **filep, size_t size, void const *path, int path_type)

Open a file from a path, in order to write its content.

Parameters:

• filep – Pointer to the file object to create.

• size – Size of the file to create or open.

• path – Path to the file to open, with the file type.

• path_type – Type of the path to the file to create or open.

Returns:

Error, or 0 if the operation was successful.

int cahute_open_stdout(cahute_file **filep)

Open standard output as a file, in order to write to it.

Warning

A file obtained through this method must be closed using cahute_close_file(), just like files opened using cahute_open_file(). It will always return a new file instance.

Parameters:

• filep – Pointer to the file object to create.

Returns:

Error, or 0 if the operation was successful.

int cahute_get_file_size(cahute_file *file, unsigned long *sizep)

Get the total size of the file.

Parameters:

• file – File object.

• sizep – Pointer to the integer to set with the file size.

Returns:

Error, or 0 if the operation was successful.

int cahute_read_from_file(cahute_file *file, unsigned long off, void *buf, size_t size)

Read from the file starting at a given offset.

Parameters:

• file – File object.

• off – Offset at which to read.

• buf – Buffer in which to write the resulting data.

• size – Size of the data to read.

Returns:

Error, or 0 if the operation was successful.

int cahute_write_to_file(cahute_file *file, unsigned long off, void const *data, size_t size)

Write to the file starting at a given offset.

Parameters:

• file – File object.

• off – Offset at which to read.

• buf – Buffer in which to write the resulting data.

• size – Size of the data to read.

Returns:

Error, or 0 if the operation was successful.

int cahute_guess_file_type(cahute_file *file, int *typep)

Get the type of a file, in order to read it.

Parameters:

• file – File object.

• typep – Value to define with the determined type for the file.

Returns:

Error, or 0 if the operation was successful.

int cahute_get_data_from_file(cahute_file *file, cahute_data **datap);

Decode data from a file opened for reading.

Parameters:

• file – File object.

• datap – Pointer to the data to create.

Returns:

Error, or 0 if the operation was successful.

void cahute_close_file(cahute_file *file)

Close a file.

Parameters:

• file – File object to close.