[[tags: allegro game]]
== allegro
This document pertains to file related methods found in the Allegro egg.
Please see the main [allegro] wiki page for more information.
[[toc:]]
== Constants
* eof
== Enums
=== file-mode
(file-mode->int file-mode)
{{file-mode}} may be one of the following symbols:
* read
* write
* execute
* hidden
* file
* directory
(int->file-mode integer)
=== seek-flag
(seek-flag->int seek-flag)
{{seek-flag}} may be one of the following symbols:
* set
* current
* end
(int->seek-flag integer)
== Records
=== file
file
=== file-interface
file-interface
=== fs-entry
fs-entry
(fs-entry-vtable fs-entry)
=== fs-interface
fs-interface
(free-fs-interface! fs-interface)
(fs-interface-create-entry fs-interface)
(fs-interface-entry-name fs-interface)
(fs-interface-update-entry fs-interface)
(fs-interface-entry-mode fs-interface)
(fs-interface-atime fs-interface)
(fs-interface-mtime fs-interface)
(fs-interface-ctime fs-interface)
(fs-interface-entry-size fs-interface)
(fs-interface-entry-exists? fs-interface)
(fs-interface-remove-entry fs-interface)
(fs-interface-open-directory fs-interface)
(fs-interface-read-directory fs-interface)
(fs-interface-close-directory fs-interface)
(fs-interface-current-directory fs-interface)
(fs-interface-make-directory fs-interface)
(fs-interface-filename-exists? fs-interface)
(fs-interface-remove-filename fs-interface)
(fs-interface-open-file fs-interface)
=== path
path
== Functions
=== File Operations
(make-temp-file* (string template) ((c-pointer path) out_path))
Implements al_make_temp_file.
(make-temp-file (string template) ((c-pointer path) out_path))
Implements al_make_temp_file, with (free&close-file!) declared as a finalizer.
(file-open* (string path) (string mode))
Implements al_fopen.
(file-open (string path) (string mode))
Implements al_fopen, with (free&close-file!) declared as a finalizer.
(file-open-fd* (integer file-descriptor) (string mode))
Implements al_fopen_fd.
(file-open-fd (integer file-descriptor) (string mode))
Implements al_fopen_fd, with (free&close-file!) declared as a finalizer.
(free&close-file! file)
Closes a file with (file-close!), then uses (free!) to clear the file struct from memory.
(file-close! file)
Implements al_fclose.
(file-read! file blob (integer size))
Implements al_fread.
(file-write! file blob (integer size))
Implements al_fwrite.
(file-tell file)(file-seek! file (integer offset) (integer whence))
Implements al_fseek.
(file-eof? file)
Implements al_feof.
(file-error? file)
Implements al_ferror.
(file-clear-error! file)
Implements al_fclearerr.
(file-unget-chars! file (integer count))
Implements al_fungetc.
(file-size file)
Implements al_fsize.
(file-get-char! file)
Implements al_fgetc.
(file-put-char! file (integer character))
Implements al_fputc.
(file-read-16le! file)
Implements al_fread16le.
(file-read-16be! file)
Implements al_fread16be.
(file-write-16le! file integer)
Implements al_fwrite16le.
(file-read-32le! file)
Implements al_fread32le.
(file-read-32be! file)
Implements al_fread32be.
(file-write-32le! file integer)
Implements al_fwrite32le.
(file-write-32be! file integer)
Implements al_fwrite32be.
(file-get-string! file blob (integer max))
Implements al_fgets.
(file-get-utf-string*! file)
Implements al_get_ustr.
(file-get-utf-string! file)
Implements al_get_ustr, with (free-utf-string!) declared as a finalizer.
(file-put-string! file string)
Implements al_fputs.
(file-userdata file)
Implements al_get_file_userdata.
(new-file-interface-set! file-interface)
Implements al_set_new_file_interface.
(file-interface-open* file-interface (string path) (string mode))
Implements al_fopen_interface.
(file-interface-open file-interface (string path) (string mode))
Implements al_fopen_interface, with (free&close-file!) declared as a finalizer.
(make-file-handle* file-interface (c-pointer userdata))
Implements al_create_file_handle.
(make-file-handle file-interface (c-pointer userdata))
Implements al_create_file_handle, with (free&close-file!) decalred as a finalizer.
=== File System Hooks
(make-fs-entry* string)
Implements al_create_fs_entry.
(make-fs-entry string)
Implements al_create_fs_entry, with (free-fs-entry!) declared as a finalizer.
(free-fs-entry! fs-entry)
Implements al_destroy_fs_entry.
(fs-entry-name fs-entry)
Implements al_get_fs_entry_name.
(fs-entry-update! fs-entry)
Implements al_update_fs_entry.
(fs-entry-mode fs-entry)
Implements al_get_fs_entry_mode.
(fs-entry-atime fs-entry)
Implements al_get_fs_entry_atime.
(fs-entry-mtime fs-entry)
Implements al_get_fs_entry_mtime.
(fs-entry-ctime fs-entry)
Implements al_get_fs_entry_ctime.
(fs-entry-size fs-entry)
Implements al_get_fs_entry_size.
(fs-entry-exists? fs-entry)
Implements al_fs_entry_exists.
(fs-entry-remove! fs-entry)
Implements al_remove_fs_entry.
(fs-entry-open fs-enty string)
Implements al_open_fs_entry.
(fs-entry-directory-open! fs-entry)
Implements al_open_directory.
(fs-entry-directory-read fs-entry)
Implements al_read_directory.
(fs-entry-directory-close! fs-entry)
Implements al_close_directory.
(current-directory)
Implements al_get_current_directory.
(change-directory string)
Implements al_change_directory.
(make-directory string)
Implements al_make_directory.
(filename-exists? string)
Implements al_filename_exists.
(filename-remove! string)
Implements al_remove_filename.
(new-file-interface)
Implements al_get_new_file_interface.
(current-fs-interface)
Implements al_get_fs_interface.
(current-fs-interface-set!)
Implements al_set_fs_interface.
(standard-fs-interface-set!)
Implements al_set_standard_fs_interface.
=== Paths
(make-path* string)
Implements al_create_path.
(make-path string)
Implements al_create_path, with (free-path!) declared as a finalizer.
(make-path-for-directory* string)
Implements al_create_path_for_directory.
(make-path-for-directory string)
Implements al_create_path_for_directory, with (free-path!) declared as a finalizer.
(free-path! path)
Implements al_destroy_path.
(path->string path (char separator))
Implements al_path_cstr.
(path-component-count path)
Implements al_get_path_num_components.
(path-component path integer)
Implements al_get_path_compoenent.
(path-component-set! path integer string)
Implements al_replace_path_component.
(path-component-remove! path integer)
Implements al_remove_path_component.
(path-component-insert! path integer string)
Implements al_insert_path_component.
(path-clone path)
Implements al_clone_path.
(path-tail path)
Implements al_get_path_tail.
(path-drop-tail! path)
Implements al_drop_path_tail.
(path-append! path string)
Implements al_append_path_component.
(path-join! path path)
Implements al_join_paths.
(path-rebase! path path)
Implements al_rebase_path.
(path-drive path)
Implements al_get_path_drive.
(path-drive-set! path string)
Implements al_set_path_drive.
(path-filename path)
Implements al_get_path_filename.
(path-filename-set! path string)
Implements al_set_path_filename.
(path-extension path)
Implements al_get_path_extension.
(path-extension-set! path string)
Implements al_set_path_extension.
(path-basename path)
Implements al_get_path_basename.
(path-make-canonical! path)
Implements al_make_path_canonical.
=== PhysicsFS
See also: the [[physfs]] egg.
(enable-physfs-file-interface)
Implements al_set_physfs_file_interface.
(physfs-addon-version)
Implements al_get_allegro_physfs_version.