libisofs-0.2.4/libisofs/libisofs.h File Reference

Go to the source code of this file.

Enumerations

enum  ecma119_extension_flag { ECMA119_ROCKRIDGE = (1<<0), ECMA119_JOLIET = (1<<1) }

Functions

iso_volume * iso_volume_new (const char *volume_id, const char *publisher_id, const char *data_preparer_id)
 Create a new volume.
iso_volume * iso_volume_new_with_root (const char *volume_id, const char *publisher_id, const char *data_preparer_id, struct iso_tree_node *root)
void iso_volume_free (struct iso_volume *volume)
 Free a volume.
void iso_volset_free (struct iso_volset *volume)
 Free a set of data volumes.
iso_tree_node * iso_volume_get_root (const struct iso_volume *volume)
 Get the root directory for a volume.
void iso_volume_set_volume_id (struct iso_volume *volume, const char *volume_id)
 Fill in the volume identifier for a volume.
void iso_volume_set_publisher_id (struct iso_volume *volume, const char *publisher_id)
 Fill in the publisher for a volume.
void iso_volume_set_data_preparer_id (struct iso_volume *volume, const char *data_preparer_id)
 Fill in the data preparer for a volume.
iso_tree_node * iso_tree_volume_path_to_node (struct iso_volume *volume, const char *path)
 Locate a node by its path on disc.
iso_tree_node * iso_tree_volume_add_path (struct iso_volume *volume, const char *disc_path, const char *path)
 Add a file or a directory (recursively) to a volume by specifying its path on the volume.
iso_tree_node * iso_tree_volume_add_new_dir (struct iso_volume *volume, const char *disc_path)
 Creates a new, empty directory on the volume.
iso_volset * iso_volset_new (struct iso_volume *volume, const char *volset_id)
 Create a new Volume Set consisting of only one volume.
iso_tree_node * iso_tree_add_node (struct iso_tree_node *parent, const char *path)
 Add a file to a directory.
iso_tree_node * iso_tree_radd_dir (struct iso_tree_node *parent, const char *path)
 Recursively add an existing directory to the tree.
void iso_exclude_add_path (const char *path)
 Add the path of a file or directory to ignore when adding a directory recursively.
void iso_exclude_remove_path (const char *path)
 Remove a path that was set to be ignored when adding a directory recusively.
void iso_exclude_empty (void)
 Remove all paths that were set to be ignored when adding a directory recusively.
iso_tree_node * iso_tree_add_new_dir (struct iso_tree_node *parent, const char *name)
 Creates a new, empty directory on the volume.
void iso_tree_node_set_name (struct iso_tree_node *file, const char *name)
 Set the name of a file (using the current locale).
void iso_tree_print (const struct iso_tree_node *root, int spaces)
 Recursively print a directory to stdout.
burn_source * iso_source_new_ecma119 (struct iso_volset *volumeset, int volnum, int level, int flags)
 Create a burn_source which can be used as a data source for a track.

Enumeration Type Documentation

enum ecma119_extension_flag

Enumerator:
ECMA119_ROCKRIDGE 
ECMA119_JOLIET 

Definition at line 36 of file libisofs.h.

00036                             {
00037     ECMA119_ROCKRIDGE   = (1<<0),
00038     ECMA119_JOLIET      = (1<<1)
00039 };

Function Documentation

void iso_exclude_add_path ( const char *  path  ) 

Add the path of a file or directory to ignore when adding a directory recursively.

Parameters:
path The path, on the local filesystem, of the file.

void iso_exclude_empty ( void   ) 

Remove all paths that were set to be ignored when adding a directory recusively.

void iso_exclude_remove_path ( const char *  path  ) 

Remove a path that was set to be ignored when adding a directory recusively.

Parameters:
path The path, on the local filesystem, of the file.

struct burn_source* iso_source_new_ecma119 ( struct iso_volset *  volumeset,
int  volnum,
int  level,
int  flags 
)

Create a burn_source which can be used as a data source for a track.

The volume set used to create the libburn_source can _not_ be modified until the libburn_source is freed.

Parameters:
volumeset The volume set from which you want to write
volnum The volume in the set which you want to write (usually 0)
level ISO level to write at.
flags Which extensions to support.
Precondition:
volumeset is non-NULL

volnum is less than volset->volset_size.

Returns:
A burn_source to be used for the data source for a track

struct iso_tree_node* iso_tree_add_new_dir ( struct iso_tree_node *  parent,
const char *  name 
)

Creates a new, empty directory on the volume.

Precondition:
parent is NULL or is a directory.

name is unique among the children and files belonging to parent. Also, it doesn't contain '/' characters.

Postcondition:
parent contains a child directory whose name is name and whose POSIX attributes are the same as parent's.
Returns:
a pointer to the newly created directory.

struct iso_tree_node* iso_tree_add_node ( struct iso_tree_node *  parent,
const char *  path 
)

Add a file to a directory.

Parameters:
path The path, on the local filesystem, of the file.
Precondition:
parent is NULL or is a directory.

path is non-NULL and is a valid path to a non-directory on the local filesystem.

Returns:
An iso_tree_node whose path is path and whose parent is parent.

void iso_tree_node_set_name ( struct iso_tree_node *  file,
const char *  name 
)

Set the name of a file (using the current locale).

void iso_tree_print ( const struct iso_tree_node *  root,
int  spaces 
)

Recursively print a directory to stdout.

Parameters:
spaces The initial number of spaces on the left. Set to 0 if you supply a root directory.

struct iso_tree_node* iso_tree_radd_dir ( struct iso_tree_node *  parent,
const char *  path 
)

Recursively add an existing directory to the tree.

Warning: when using this, you'll lose pointers to files or subdirectories. If you want to have pointers to all files and directories, use iso_tree_add_file and iso_tree_add_dir.

Parameters:
path The path, on the local filesystem, of the directory to add.
Precondition:
parent is NULL or is a directory.

path is non-NULL and is a valid path to a directory on the local filesystem.

Returns:
a pointer to the newly created directory.

struct iso_tree_node* iso_tree_volume_add_new_dir ( struct iso_volume *  volume,
const char *  disc_path 
)

Creates a new, empty directory on the volume.

Parameters:
volume The volume to add the directory to.
disc_path The path on the volume at which to add the directory.
Returns:
A pointer to the newly created directory.

struct iso_tree_node* iso_tree_volume_add_path ( struct iso_volume *  volume,
const char *  disc_path,
const char *  path 
)

Add a file or a directory (recursively) to a volume by specifying its path on the volume.

Parameters:
volume The volume to add the file to.
disc_path The path on the disc at which to add the disc.
path The path, on the local filesystem, of the file.
Returns:
The node for the file or NULL if the parent doesn't exists on the disc.

struct iso_tree_node* iso_tree_volume_path_to_node ( struct iso_volume *  volume,
const char *  path 
)

Locate a node by its path on disc.

Parameters:
volume The volume to search in.
path The path, in the image, of the file.
Returns:
The node found or NULL.

void iso_volset_free ( struct iso_volset *  volume  ) 

Free a set of data volumes.

struct iso_volset* iso_volset_new ( struct iso_volume *  volume,
const char *  volset_id 
)

Create a new Volume Set consisting of only one volume.

Parameters:
volume The first and only volume for the volset to contain.
volset_id The Volume Set ID.
Returns:
A new iso_volset.

void iso_volume_free ( struct iso_volume *  volume  ) 

Free a volume.

struct iso_tree_node* iso_volume_get_root ( const struct iso_volume *  volume  ) 

Get the root directory for a volume.

struct iso_volume* iso_volume_new ( const char *  volume_id,
const char *  publisher_id,
const char *  data_preparer_id 
)

Create a new volume.

The parameters can be set to NULL if you wish to set them later.

struct iso_volume* iso_volume_new_with_root ( const char *  volume_id,
const char *  publisher_id,
const char *  data_preparer_id,
struct iso_tree_node *  root 
)

void iso_volume_set_data_preparer_id ( struct iso_volume *  volume,
const char *  data_preparer_id 
)

Fill in the data preparer for a volume.

void iso_volume_set_publisher_id ( struct iso_volume *  volume,
const char *  publisher_id 
)

Fill in the publisher for a volume.

void iso_volume_set_volume_id ( struct iso_volume *  volume,
const char *  volume_id 
)

Fill in the volume identifier for a volume.

Generated on Sun Jun 10 09:44:37 2007 for libisofs by  doxygen 1.5.1