enum GFileError

typedef enum
{
  G_FILE_ERROR_EXIST,
  G_FILE_ERROR_ISDIR,
  G_FILE_ERROR_ACCES,
  G_FILE_ERROR_NAMETOOLONG,
  G_FILE_ERROR_NOENT,
  G_FILE_ERROR_NOTDIR,
  G_FILE_ERROR_NXIO,
  G_FILE_ERROR_NODEV,
  G_FILE_ERROR_ROFS,
  G_FILE_ERROR_TXTBSY,
  G_FILE_ERROR_FAULT,
  G_FILE_ERROR_LOOP,
  G_FILE_ERROR_NOSPC,
  G_FILE_ERROR_NOMEM,
  G_FILE_ERROR_MFILE,
  G_FILE_ERROR_NFILE,
  G_FILE_ERROR_BADF,
  G_FILE_ERROR_INVAL,
  G_FILE_ERROR_PIPE,
  G_FILE_ERROR_AGAIN,
  G_FILE_ERROR_INTR,
  G_FILE_ERROR_IO,
  G_FILE_ERROR_PERM,
  G_FILE_ERROR_NOSYS,
  G_FILE_ERROR_FAILED
} GFileError;

Значения соответствующие errno кодам возвращаемым из файловых операций в UNIX. В отличие от errno кодов, GFileError значения доступны во всех системах, даже в Windows. Точное значение каждого кода зависит от выполняемой вами опреции; UNIX документация даёт больше деталей. Следующие описания error кодов взяты из руководства GNU C Library и находятся под действие копирайта этого руководства.

Это не очень переносимо для создания подробного предположения о точных ошибках которые будут возвращены из полученной операции. Некоторые ошибки не происходят в некоторых системах и т.д., иногда есть тонкое различие в том когда система сообщит о полученной ошибке и т.д..

G_FILE_ERROR

#define G_FILE_ERROR g_file_error_quark ()

Домен ошибки для файловых операций. Ошибки в этом домене из перечисления GFileError. Смотрите GError для информации о доменах ошибки.

enum GFileTest

typedef enum
{
  G_FILE_TEST_IS_REGULAR    = 1 << 0,
  G_FILE_TEST_IS_SYMLINK    = 1 << 1,
  G_FILE_TEST_IS_DIR        = 1 << 2,
  G_FILE_TEST_IS_EXECUTABLE = 1 << 3,
  G_FILE_TEST_EXISTS        = 1 << 4
} GFileTest;

Перечисление для тестирования файла используя g_file_test().

g_file_error_from_errno ()

GFileError  g_file_error_from_errno         (gint err_no);

Получает константу GFileError основанную на помещённой errno. Например, если вы поместили EEXIST эта функция вернёт G_FILE_ERROR_EXIST. В отличие от значений errno, вы можете предполагать что все значения GFileError будут существовать при портировании.

Обычно значение GFileError происходит из GError возвращаемой из функций манипулирования файлами. Поэтому вы должны использовать g_file_error_from_errno() при создании GError.

g_file_get_contents ()

gboolean    g_file_get_contents             (const gchar *filename,
                                             gchar **contents,
                                             gsize *length,
                                             GError **error);

Читает весь файл в распределённую память, с хорошей проверкой ошибок.

Если вызов был выполнен успешно, то возвращает TRUE и устанавливает contents в файловый контекст, а length в длину файлового контекста в байтах. Строка сохраняемая в contents будет nul-завершённой, таким образом для текстового файла вы можете поместить NULL для аргумента length. Если вызов не выполнен, то возвращает FALSE и устанавливает error. Домен ошибки это G_FILE_ERROR. Возможные коды ошибок берутся в перечислении GFileError. В случае ошибки, contents устанавливается в значение NULL, а length в нулевое значение.

g_file_set_contents ()

gboolean    g_file_set_contents             (const gchar *filename,
                                             const gchar *contents,
                                             gssize length,
                                             GError **error);

Записывает весь contents в файл с именем filename, с хорошим контролем ошибок. Если файл с именем filename уже существует он будет переписан.

Эта запись атомарная в том смысле что сначала записывается в во временный файл который затем переименовывается в конечное имя. Помните:

Если вызов был успешен, возвращает TRUE. Если вызов неудался, возвращает FALSE и устанавливает error. Домен ошибки - G_FILE_ERROR. Возможные коды ошибок берутся из перечисления GFileError enumeration.

Начиная с версии 2.8

g_file_test ()

gboolean    g_file_test                     (const gchar *filename,
                                             GFileTest test);

Возвращает TRUE если любой из тестов в битовом поле test является TRUE. Например, (G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR) вернёт TRUE если файл существует; проверка является ли он каталогом не имеет значения, так как тест существования имеет значение TRUE. С текущем набором доступных тестов, нет никакого смысла помещать больше чем один тест одновременно.

Помимо G_FILE_TEST_IS_SYMLINK все тесты поддерживают символические тесты, поэтому для символической ссылки на обычный файл g_file_test() вернёт TRUE и для G_FILE_TEST_IS_SYMLINK и для G_FILE_TEST_IS_REGULAR.

Помните, для висящей символической ссылки g_file_test() вернёт TRUE для G_FILE_TEST_IS_SYMLINK и FALSE для других флагов.

Вы никогда не должны использовать g_file_test() для тестирования безопасности операции, потомучто всегда есть возможность условия изменяющегося прежде чем вы фактически выполнили операцию. Например, вы можете подумать что можно использовать G_FILE_TEST_IS_SYMLINK, чтобы определить можно ли безопасно записать в файл не опасаясь что он находится в другом месте. Это не работает!

/* Не делайте это */
 if (!g_file_test (filename, G_FILE_TEST_IS_SYMLINK)) {
   fd = g_open (filename, O_WRONLY);
   /* запись в fd */
 }

Также помните что G_FILE_TEST_EXISTS и G_FILE_TEST_IS_EXECUTABLE реализованы с использованием системного вызова access(). Это обычно не имеет значения, но если ваша программа имеет setuid или setgid это значит что эти тесты дадут вам ответ для реального user ID и group ID, а не действующего user ID и group ID.

В Windows, нет символических ссылок, поэтому тест для G_FILE_TEST_IS_SYMLINK будет всегда возвращать FALSE. Тест для G_FILE_TEST_IS_EXECUTABLE будет просто проверять что файл существует и его имя указывает что он исполняемый, проверяя известные расширения и их список в переменной окружения PATHEXT.

g_mkstemp ()

gint        g_mkstemp                       (gchar *tmpl);

Открывает временный файл. Смотрите документацию mkstemp() в большинстве UNIX-подобных системах.

В качестве параметра используется строка которая должна соответствовать правилам шаблонов mkstemp(), то есть содержать строку "XXXXXX". g_mkstemp() более гибкая чем mkstemp() в которой последовательность не должна находится в самом конце шаблона. Строка X изменяется для формирования имени не существующего файла. Строка должна быть в кодировке имён файлов GLib. Наиболее важно что в Windows она должна быть в UTF-8.

g_file_open_tmp ()

gint        g_file_open_tmp                 (const gchar *tmpl,
                                             gchar **name_used,
                                             GError **error);

Открывает файл для записи в привилегированный каталог временных файлов (который возвращается из g_get_tmp_dir()).

tmpl должен быть строкой в кодировке имён файлов GLib содержащей последовательность шести символов 'X', также как параметр в g_mkstemp(). Однако в отличие от этой функции, шаблон должен быть только базовым именем, ни какие компоненты каталога не допускаются. Если шаблон NULL, используется шаблон по умолчанию.

Помните что в отличие от g_mkstemp() (и mkstemp()) tmpl не изменяется, и может таким образом быть буквенной строкой только для чтения.

Фактически используется имя возвращаемое в name_used если не-NULL. Эта строка должна быть освобождена с помощью g_free() когда больше не нужна. Возвращаемое имя находится в кодировке имён файлов GLib.

g_file_read_link ()

gchar*      g_file_read_link                (const gchar *filename,
                                             GError **error);

Читает содержимое символической ссылки filename также как POSIX функция readlink(). Возвращаемая строка находится в кодировке используемой для имён файлов. Использует g_filename_to_utf8() для конвертации в UTF-8.

Начиная с версии 2.4

g_mkdir_with_parents ()

int         g_mkdir_with_parents            (const gchar *pathname,
                                             int mode);

Создаёт каталог если он ещё не существует. Также создаёт необходимые промежуточные родительские каталоги.

Начиная с версии 2.8

GDir

typedef struct _GDir GDir;

Непрозрачная структура представляющая открытый каталог.

g_dir_open ()

GDir*       g_dir_open                      (const gchar *path,
                                             guint flags,
                                             GError **error);

Открывает каталог для чтения. Имена файлов в каталоге могут быть найдены с помощью g_dir_read_name().

g_dir_read_name ()

const gchar* g_dir_read_name                (GDir *dir);

Находит имя следующего входа в каталоге. Входы '.' и '..' пропускаются. В Windows, возвращаемое имя находится в кодировке UTF-8. В Unix, она находится в дисковой кодировке (on-disk encoding).

g_dir_rewind ()

void        g_dir_rewind                    (GDir *dir);

Сбрасывает полученный каталог до первой записи. Следующий вызов g_dir_read_name() снова вернёт первый вход.

g_dir_close ()

void        g_dir_close                     (GDir *dir);

Закрывает каталоги и освобождает все связанные с ними ресурсы.

GMappedFile

typedef struct _GMappedFile GMappedFile;

GMappedFile представляет отображение файла созданное с помощью g_mapped_file_new(). Она имеет только закрытые элементы и не должна использоваться непосредственно.

g_mapped_file_new ()

GMappedFile* g_mapped_file_new              (const gchar *filename,
                                             gboolean writable,
                                             GError **error);

Отображает файл в памяти. В UNIX, она использует функцию mmap().

Если writable равна TRUE, буфер отображения может модифицироваться, иначе она представляет ошибку для изменения отображённого буфера. Модификации буфера невидимы для других процессов отображающих тот же файл и не записываются обратно в файл.

Помните что модификации основного файла могут затронуть содержимое GMappedFile. Поэтому отображение должно использоваться только если файл не будет изменён, или все модификации файла сделаны атомарно (например используя g_file_set_contents()).

Начиная с версии 2.8

g_mapped_file_free ()

void        g_mapped_file_free              (GMappedFile *file);

Сбрасывает буфер отображения для file и освобождает его.

Начиная с версии 2.8

g_mapped_file_get_length ()

gsize       g_mapped_file_get_length        (GMappedFile *file);

Возвращает размер содержимого GMappedFile.

Начиная с версии 2.8

g_mapped_file_get_contents ()

gchar*      g_mapped_file_get_contents      (GMappedFile *file);

Returns the contents of a GMappedFile.

Помните что содержимое может быть не ноль-завершённым (zero-terminated), даже если GMappedFile поддерживается текстовым файлом.

Начиная с версии 2.8

g_open ()

int         g_open                          (const gchar *filename,
                                             int flags,
                                             int mode);

Оболочка для POSIX функции open(). Функция open() используется для конвертации имени пути в дескриптор файла. Помните что в POSIX системах дескриптор файла реализуется системной операцией. В Windows, это C библиотека которая реализует open() и дескриптор файла. Фактическое Windows API для открытия файлов является другим.

Смотрите руководство C library для детальной информации о open().

Начиная с версии 2.6

g_rename ()

int         g_rename                        (const gchar *oldfilename,
                                             const gchar *newfilename);

Оболочка для POSIX функции rename(). Функция rename() переименовывает файл, перемещая его между каталогами если необходимо.

Смотрите руководство для вашей C библиотеки для получения деталей о том как работает rename() в вашей системе. Помните что в Win9x не возможно переименовать файл если файл с новым именем уже существует. Также это не возможно вообще в Windows для открытых файлов.

Начиная с версии 2.6

g_mkdir ()

int         g_mkdir                         (const gchar *filename,
                                             int mode);

Оболочка для POSIX функции mkdir(). Функция mkdir() пытается создать каталог с полученным именем и правами доступа.

Смотрите руководство C библиотеки для больших деталей о mkdir().

Начиная с версии 2.6

g_stat ()

int         g_stat                          (const gchar *filename,
                                             struct stat *buf);

Оболочка для POSIX функции stat(). Функция stat() возвращает информацию о файле.

Смотрите руководство C библиотеки для больших деталей о stat().

Начиная с версии 2.6

g_lstat ()

int         g_lstat                         (const gchar *filename,
                                             struct stat *buf);

Оболочка для POSIX функции lstat(). Функция lstat() похожа на stat() за исключением того что в случае символической ссылки она возвращает информацию о символической ссылке непосредственно, а не о файле на который она ссылается. Если система не поддерживает символических ссылок g_lstat() идентична g_stat().

Смотрите руководство C библиотеки для больших деталей о lstat().

Начиная с версии 2.6

g_unlink ()

int         g_unlink                        (const gchar *filename);

Оболочка для POSIX функции unlink(). Функция unlink() удаляет имя из файловой системы. Если оно было последней ссылкой на файл и нет процессов открывших его, дисковое пространство освобождается от файла.

Смотрите руководство C библиотеки для больших деталей о unlink(). Помните что в Windows, она не может удалить файлы которые открыты каким нибудь процессом, или отображены в памяти.

Начиная с версии 2.6

g_remove ()

int         g_remove                        (const gchar *filename);

Оболочка для POSIX функции remove(). Функция remove() удаляет имя файла из файловой системы.

Смотрите руководство C библиотеки для больших деталей о том как работает remove() в вашей системе. В Unix, remove() удаляет также каталоги, так как она вызывает unlink() для файлов и rmdir() для каталогов. В Windows, хотя remove() в C библиотеке работает только для файлов, эта функция вызовет сначала remove() а затем если это не удалось rmdir(), поэтому работает и для файлов и для каталогов. Помните однако, что в Windows, она не сможет удалить файл который открыт каким нибудь процессом, или отображён в память.

Если эта функция закончилась неудачно в Windows вы не можете получить слишком много из значения ошибки. rmdir() пробует выполниться не зависимо от того что remove() завершилась неудачно. Любое значение errno установленное remove() будет переписано rmdir().

Начиная с версии 2.6

g_rmdir ()

int         g_rmdir                         (const gchar *filename);

Оболочка для POSIX функции rmdir(). Функция rmdir() каталог из файловой системы.

Смотрите руководство C библиотеки для больших деталей о том как работает rmdir() в вашей системе.

Начиная с версии 2.6

g_fopen ()

FILE*       g_fopen                         (const gchar *filename,
                                             const gchar *mode);

Оболочка для POSIX функции fopen(). Функция fopen() открывает файл и связывает его с новым потоком.

Смотрите руководство C библиотеки для деталей о fopen().

Начиная с версии 2.6

g_freopen ()

FILE*       g_freopen                       (const gchar *filename,
                                             const gchar *mode,
                                             FILE *stream);

A wrapper for the POSIX freopen() function. The freopen() function opens a file and associates it with an existing stream.

Смотрите руководство С библиотеки для больших деталей о freopen().

Начиная с версии 2.6

g_chmod ()

int         g_chmod                         (const gchar *filename,
                                             int mode);

A wrapper for the POSIX chmod() function. The chmod() function is used to set the permissions of a file system object. Note that on Windows the file protection mechanism is not at all POSIX-like, and the underlying chmod() function in the C library just sets or clears the READONLY attribute. It does not touch any ACL. Software that needs to manage file permissions on Windows exactly should use the Win32 API.

Смотрите руководство С библиотеки для больших деталей о chmod().

Начиная с версии 2.8

g_access ()

int         g_access                        (const gchar *filename,
                                             int mode);

Оболочка для POSIX функции access(). Эта функция используется для тестирования имени пути на доступ чтения, записи или исполнения, или просто существование. В Windows, основная функция access() в C библиотеке только проверяет параметр READONLY, и не смотрите остальные ACL. Программное обеспечение, которое должно более точно обрабатывать права доступа в Windows, должно использовать Win32 API.

Смотрите руководство С библиотеки для больших деталей о access().

Начиная с версии 2.8

g_creat ()

int         g_creat                         (const gchar *filename,
                                             int mode);

Оболочка для POSIX функции creat(). Функция creat() используется для конвертации имени пути в дескриптор файла, создавая файл если необходимо. Помните что в POSIX системах дескриптор файла реализуется операционной системой. В Windows, это выполняет C библиотека которая реализует creat() и дескриптор файла. Фактически Windows API для открытия файлов несколько другое.

Смотрите руководство С библиотеки для больших деталей о creat().

Начиная с версии 2.8

g_chdir ()

int         g_chdir                         (const gchar *path);

Оболочка для POSIX функции chdir(). Функция изменяет текущий каталог процесса на path.

Смотрите руководство вашей C библиотеки для больших деталей о chdir().

Начиная с версии 2.8