group.c File Reference

#include <string.h>
#include "mape/cpp-handles/group-handle.h"
#include "mape/group.h"

Include dependency graph for group.c:

Go to the source code of this file.

Classes
struct	_MapeGroupPrivate

Macros
#define	MAPE_GROUP_PRIVATE(obj)   (G_TYPE_INSTANCE_GET_PRIVATE((obj), MAPE_TYPE_GROUP, MapeGroupPrivate))

Typedefs
typedef struct _MapeGroupPrivate	MapeGroupPrivate

Enumerations
enum	{ PROP_0 , PROP_NAME , PROP_FULL_NAME }

Functions
C4GroupHandle *	_mape_group_get_handle (MapeGroup *group)
MapeGroup *	mape_group_new (void)
gboolean	mape_group_is_open (MapeGroup *group)
gboolean	mape_group_open (MapeGroup *group, const gchar *path, GError **error)
MapeGroup *	mape_group_open_child (MapeGroup *group, const gchar *entry, GError **error)
void	mape_group_close (MapeGroup *group)
const gchar *	mape_group_get_name (MapeGroup *group)
gchar *	mape_group_get_full_name (MapeGroup *group)
gboolean	mape_group_has_entry (MapeGroup *group, const gchar *entry)
void	mape_group_rewind (MapeGroup *group)
gchar *	mape_group_get_next_entry (MapeGroup *group)
guchar *	mape_group_load_entry (MapeGroup *group, const gchar *entry, gsize *size, GError **error)
gboolean	mape_group_is_drive_container (MapeGroup *group)
gboolean	mape_group_is_child_folder (MapeGroup *group, const gchar *child)

---

Class Documentation

_MapeGroupPrivate

struct _MapeGroupPrivate

Definition at line 42 of file group.c.

Class Members
C4GroupHandle *	handle

Macro Definition Documentation

MAPE_GROUP_PRIVATE

#define MAPE_GROUP_PRIVATE

(

obj

)

(G_TYPE_INSTANCE_GET_PRIVATE((obj), MAPE_TYPE_GROUP, MapeGroupPrivate))

Definition at line 63 of file group.c.

Typedef Documentation

MapeGroupPrivate

typedef struct _MapeGroupPrivate MapeGroupPrivate

Definition at line 39 of file group.c.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
PROP_0
PROP_NAME
PROP_FULL_NAME

Definition at line 55 of file group.c.

     {
  PROP_0,
 
  /* read only */
  PROP_NAME,
  PROP_FULL_NAME
};

Function Documentation

_mape_group_get_handle()

C4GroupHandle * _mape_group_get_handle

(

MapeGroup *

group

)

SECTION:mape-group @title: MapeGroup @short_description: C4Group interface mape/group.h @stability: Unstable

MapeGroup is a simple GObject-based interface to C4Group. It currntly only supports a subset of the C4Group operations, it does not support writing groups for example. It is just enough for what Mape requires.

Definition at line 682 of file group.c.

{
  g_return_val_if_fail(MAPE_IS_GROUP(group), NULL);
  return MAPE_GROUP_PRIVATE(group)->handle;
}

References MAPE_GROUP_PRIVATE, and MAPE_IS_GROUP.

Referenced by mape_mapgen_set_root_group(), mape_material_map_load(), and mape_texture_map_load_map().

Here is the caller graph for this function:

mape_group_close()

void mape_group_close

(

MapeGroup *

group

)

mape_group_close: @group: A MapeGroup.

Closes an open group. The group can be reopened afterwards.

Definition at line 355 of file group.c.

{
  MapeGroupPrivate* priv;
 
  g_return_if_fail(MAPE_IS_GROUP(group));
  g_return_if_fail(mape_group_is_open(group) == FALSE);
 
  priv = MAPE_GROUP_PRIVATE(group);
 
#ifdef G_OS_WIN32
  priv->drive = 0;
#endif
 
  if(priv->handle != NULL)
  {
    c4_group_handle_free(priv->handle);
    priv->handle = NULL;
 
    /* Don't notify when only drive was reset, as name and full-name are
     * not specified for these anyway (yet). */
    g_object_notify(G_OBJECT(group), "name");
    g_object_notify(G_OBJECT(group), "full-name");
  }
}

References c4_group_handle_free(), _MapeGroupPrivate::handle, mape_group_is_open(), MAPE_GROUP_PRIVATE, and MAPE_IS_GROUP.

Here is the call graph for this function:

mape_group_get_full_name()

gchar* mape_group_get_full_name

(

MapeGroup *

group

)

mape_group_get_full_name: @group: An open MapeGroup.

Returns the full path to the group.

Return Value: The group path. Free with g_free() when no longer needed.

Definition at line 407 of file group.c.

{
  g_return_val_if_fail(MAPE_IS_GROUP(group), NULL);
  g_return_val_if_fail(mape_group_is_open(group), NULL);
 
  return c4_group_handle_get_full_name(MAPE_GROUP_PRIVATE(group)->handle);
}

References c4_group_handle_get_full_name(), mape_group_is_open(), MAPE_GROUP_PRIVATE, and MAPE_IS_GROUP.

Here is the call graph for this function:

mape_group_get_name()

const gchar* mape_group_get_name

(

MapeGroup *

group

)

mape_group_get_name: @group: An open MapeGroup.

Returns the name of the group.

Return Value: The group's name. The name is owned by the group and must not be freed.

Definition at line 390 of file group.c.

{
  g_return_val_if_fail(MAPE_IS_GROUP(group), NULL);
  g_return_val_if_fail(mape_group_is_open(group), NULL);
 
  return c4_group_handle_get_name(MAPE_GROUP_PRIVATE(group)->handle);
}

References c4_group_handle_get_name(), mape_group_is_open(), MAPE_GROUP_PRIVATE, and MAPE_IS_GROUP.

Here is the call graph for this function:

mape_group_get_next_entry()

gchar* mape_group_get_next_entry

(

MapeGroup *

group

)

mape_group_get_next_entry: @group: An open MapeGroup. @error: Location to store error information, if any.

Advances the group's internal iterator by one and returns the name of the entry it now points to. Use mape_group_load_entry() to load its contents into memory, or mape_group_open_child() if you expect the entry to be a subgroup. If there are no more entries in the group, the function returns NULL.

Returns: The name of the next entry, or NULL if there is no next entry.

Definition at line 496 of file group.c.

{
  MapeGroupPrivate* priv;
  gchar* buf;
#ifdef G_OS_WIN32
  DWORD drv_c;
  guint drive;
#endif
 
  g_return_val_if_fail(MAPE_IS_GROUP(group), NULL);
  g_return_val_if_fail(mape_group_is_open(group), NULL);
 
  priv = MAPE_GROUP_PRIVATE(group);
 
#ifdef G_OS_WIN32
  static const guint DRV_C_SUPPORT = 26;
  if(priv->handle == NULL)
  {
    drv_c = GetLogicalDrives();
 
    /* Find next available drive or wait for overflow */
    drive = priv->drive - 1;
    while( (drive < DRV_C_SUPPORT) && ((~drv_c & (1 << drive)) != 0))
      ++drive;
    if(drive >= DRV_C_SUPPORT) return NULL;
 
    buf = g_malloc(3 * sizeof(gchar));
    buf[0] = 'A' + drive;
    buf[1] = ':';
    buf[2] = '\0';
    priv->drive = drive + 2;
 
    return buf;
  }
#endif
 
  buf = g_malloc(512 * sizeof(gchar));
  if(!c4_group_handle_find_next_entry(priv->handle, "*", NULL, buf, FALSE))
  {
    g_free(buf);
    buf = NULL;
  }
 
  return buf;
}

References c4_group_handle_find_next_entry(), _MapeGroupPrivate::handle, mape_group_is_open(), MAPE_GROUP_PRIVATE, and MAPE_IS_GROUP.

Referenced by mape_texture_map_load_textures().

Here is the call graph for this function:

Here is the caller graph for this function:

mape_group_has_entry()

gboolean mape_group_has_entry	(	MapeGroup *	group,
		const gchar *	entry
	)

mape_group_has_entry: @group: An open MapeGroup. @entry: The entry name to check.

Returns TRUE if @group contains an entry with the given name, and FALSE otherwise.

Definition at line 424 of file group.c.

{
  MapeGroupPrivate* priv;
#ifdef G_OS_WIN32
  DWORD chk_drv;
#endif
 
  g_return_val_if_fail(MAPE_IS_GROUP(group), FALSE);
  g_return_val_if_fail(mape_group_is_open(group), FALSE);
  g_return_val_if_fail(entry != NULL, FALSE);
 
  priv = MAPE_GROUP_PRIVATE(group);
 
#ifdef G_OS_WIN32
  if(priv->handle == NULL)
  {
    if(entry[0] == '\0') return FALSE;
    if(entry[1] != ':') return FALSE;
 
    chk_drv = 1 << (entry[0] - 'A');
    return (GetLogicalDrives() & chk_drv) != 0;
  }
#endif
 
  c4_group_handle_reset_search(priv->handle);
  return c4_group_handle_find_next_entry(priv->handle, entry,
                                         NULL, NULL, FALSE);
}

References c4_group_handle_find_next_entry(), c4_group_handle_reset_search(), _MapeGroupPrivate::handle, mape_group_is_open(), MAPE_GROUP_PRIVATE, and MAPE_IS_GROUP.

Here is the call graph for this function:

mape_group_is_child_folder()

gboolean mape_group_is_child_folder	(	MapeGroup *	group,
		const gchar *	child
	)

Definition at line 631 of file group.c.

{
  MapeGroupPrivate* priv;
  const gchar* ext;
  gchar* fullname;
  gchar* filename;
  gboolean result;
 
  g_return_val_if_fail(MAPE_IS_GROUP(group), FALSE);
  g_return_val_if_fail(mape_group_is_open(group), FALSE);
  g_return_val_if_fail(child != NULL, FALSE);
 
  priv = MAPE_GROUP_PRIVATE(group);
 
#ifdef G_OS_WIN32
  /* Drives are always folders */
  if(priv->handle == NULL)
    return TRUE;
#endif
 
  /* Guess on extension */
  ext = strrchr(child, '.');
  if(ext != NULL)
  {
    if(g_ascii_strcasecmp(ext, ".ocs") == 0 ||
       g_ascii_strcasecmp(ext, ".ocd") == 0 ||
       g_ascii_strcasecmp(ext, ".ocf") == 0 ||
       g_ascii_strcasecmp(ext, ".ocg") == 0)
   {
     return TRUE;
   }
  }
 
  /* Otherwise assume it's not a subgroup */
  if(!c4_group_handle_is_folder(priv->handle))
    return FALSE;
 
  /* It is an open directory - check for regular directory */
  fullname = c4_group_handle_get_full_name(priv->handle);
  filename = g_build_filename(fullname, child, NULL);
  g_free(fullname);
 
  result = g_file_test(filename, G_FILE_TEST_IS_DIR);
  g_free(filename);
 
  return result;
}

References c4_group_handle_get_full_name(), c4_group_handle_is_folder(), _MapeGroupPrivate::handle, mape_group_is_open(), MAPE_GROUP_PRIVATE, and MAPE_IS_GROUP.

Here is the call graph for this function:

mape_group_is_drive_container()

gboolean mape_group_is_drive_container

(

MapeGroup *

group

)

Definition at line 603 of file group.c.

{
  g_return_val_if_fail(MAPE_IS_GROUP(group), FALSE);
  g_return_val_if_fail(mape_group_is_open(group), FALSE);
 
#ifdef G_OS_WIN32
  {
    MapeGroupPrivate* priv = MAPE_GROUP_PRIVATE(group);
    if(priv->handle == NULL)
      return TRUE;
  }
#endif
 
  return FALSE;
}

References _MapeGroupPrivate::handle, mape_group_is_open(), MAPE_GROUP_PRIVATE, and MAPE_IS_GROUP.

Here is the call graph for this function:

mape_group_is_open()

gboolean mape_group_is_open

(

MapeGroup *

group

)

mape_group_is_open: @group: A MapeGroup.

Returns whether @group is open or not.

Returns: Whether @group is open.

Definition at line 220 of file group.c.

{
  MapeGroupPrivate* priv;
 
  g_return_val_if_fail(MAPE_IS_GROUP(group), FALSE);
 
  priv = MAPE_GROUP_PRIVATE(group);
 
  if(priv->handle != NULL) return TRUE;
#ifdef G_OS_WIN32
  if(priv->drive != 0) return TRUE;
#endif
  return FALSE;
}

References _MapeGroupPrivate::handle, MAPE_GROUP_PRIVATE, and MAPE_IS_GROUP.

Referenced by mape_group_close(), mape_group_get_full_name(), mape_group_get_name(), mape_group_get_next_entry(), mape_group_has_entry(), mape_group_is_child_folder(), mape_group_is_drive_container(), mape_group_load_entry(), mape_group_open(), mape_group_open_child(), mape_group_rewind(), and mape_material_map_load().

Here is the caller graph for this function:

mape_group_load_entry()

guchar* mape_group_load_entry	(	MapeGroup *	group,
		const gchar *	entry,
		gsize *	size,
		GError **	error
	)

mape_group_load_entry: @group: An open MapeGroup. @entry: The name of the file to open. @size: Location to store the size of the entry in, or NULL. @error: Location to store error information, if any.

Attempts to load the entry with the given name into memory. If @size is non-NULL, the size of the entry will be stored at the location @size points to. On error, NULL is returned, @error is set and @size is left untouched.

Returns: A pointer pointing to the loaded entry's contents.

Definition at line 557 of file group.c.

{
  MapeGroupPrivate* priv;
  gsize s;
  guchar* res;
 
  g_return_val_if_fail(MAPE_IS_GROUP(group), NULL);
  g_return_val_if_fail(mape_group_is_open(group), NULL);
  g_return_val_if_fail(error == NULL || *error == NULL, NULL);
 
  priv = MAPE_GROUP_PRIVATE(group);
  if(!c4_group_handle_access_entry(priv->handle, entry, &s, NULL, FALSE))
  {
    g_set_error(error, mape_group_error_quark, MAPE_GROUP_ERROR_ACCESS,
              "%s", c4_group_handle_get_error(priv->handle));
    return NULL;
  }
 
  res = g_malloc(s);
  if(!c4_group_handle_read(priv->handle, (char*)res, s))
  {
    g_set_error(error, mape_group_error_quark, MAPE_GROUP_ERROR_READ,
                "%s", c4_group_handle_get_error(priv->handle));
    g_free(res);
    return NULL;
  }
 
  if(size != NULL) *size = s;
  return res;
}

References c4_group_handle_access_entry(), _MapeGroupPrivate::handle, mape_group_is_open(), MAPE_GROUP_PRIVATE, MAPE_IS_GROUP, and s.

Referenced by mape_texture_map_load_textures().

Here is the call graph for this function:

Here is the caller graph for this function:

mape_group_new()

MapeGroup* mape_group_new

(

void

)

mape_group_new:

Creates a new group object. The group object is initially closed. Open it with mape_group_open(). To open a child group from an existing group, use mape_group_open_child() instead of this function.

Return Value: A new MapeGroup. Free with g_object_unref().

Definition at line 206 of file group.c.

{
  return MAPE_GROUP(g_object_new(MAPE_TYPE_GROUP, NULL));
}

References MAPE_GROUP, and MAPE_TYPE_GROUP.

Referenced by mape_group_open_child().

Here is the caller graph for this function:

mape_group_open()

gboolean mape_group_open	(	MapeGroup *	group,
		const gchar *	path,
		GError **	error
	)

mape_group_open: @group: A MapeGroup. @path: A path leading to a non-packed C4Group file or a directory on disk. @error: Location to store error information, if any.

@group must not be open yet. Upon success, @group has been opened and its content can be read via mape_group_get_next_entry() and mape_group_load_entry(). On error, the function returns FALSE and @error will be set.

Return Value: TRUE on success, and FALSE on error.

Definition at line 249 of file group.c.

{
  MapeGroupPrivate* priv;
 
  g_return_val_if_fail(MAPE_IS_GROUP(group), FALSE);
  g_return_val_if_fail(path != NULL, FALSE);
  g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
  g_return_val_if_fail(mape_group_is_open(group) == FALSE, FALSE);
 
  priv = MAPE_GROUP_PRIVATE(group);
 
#ifdef G_OS_WIN32
  if(strcmp(path, "/") == 0)
  {
    priv->drive = 1;
    return TRUE;
  }
#endif
 
  priv->handle = c4_group_handle_new();
  if(c4_group_handle_open(priv->handle, path, FALSE) == FALSE)
  {
    g_set_error(error, mape_group_error_quark, MAPE_GROUP_ERROR_OPEN,
                "Could not open '%s': %s", path,
                c4_group_handle_get_error(priv->handle));
    c4_group_handle_free(priv->handle);
    priv->handle = NULL;
    return FALSE;
  }
 
  g_object_notify(G_OBJECT(group), "name");
  g_object_notify(G_OBJECT(group), "full-name");
 
  return TRUE;
}

References c4_group_handle_new(), c4_group_handle_open(), _MapeGroupPrivate::handle, mape_group_is_open(), MAPE_GROUP_PRIVATE, and MAPE_IS_GROUP.

Referenced by mape_group_open_child().

Here is the call graph for this function:

Here is the caller graph for this function:

mape_group_open_child()

MapeGroup* mape_group_open_child	(	MapeGroup *	group,
		const gchar *	entry,
		GError **	error
	)

mape_group_open_child: @group: A MapeGroup. @entry: A subgroup entry in @group. @error: Location to store error information, if any.

This function attempts to open a child group which is contained in @group, named @entry. On success the new, opened group is returned. On failure, the function returns NULL and @error is set.

Returns: A new group to be freed with g_object_unref() when no longer needed, or NULL on error.

Definition at line 301 of file group.c.

{
  MapeGroupPrivate* parent_priv;
  MapeGroup* child;
  MapeGroupPrivate* child_priv;
  C4GroupHandle* child_handle;
 
  g_return_val_if_fail(MAPE_IS_GROUP(group), NULL);
  g_return_val_if_fail(entry != NULL, NULL);
  g_return_val_if_fail(error == NULL || *error == NULL, NULL);
  g_return_val_if_fail(mape_group_is_open(group) == TRUE, NULL);
 
  parent_priv = MAPE_GROUP_PRIVATE(group);
#ifdef G_OS_WIN32
  if(parent_priv->handle == NULL)
  {
    child = mape_group_new();
    if(!mape_group_open(child, entry, error))
    {
      g_object_unref(child);
      return NULL;
    }
 
    return child;
  }
#endif
 
  child_handle = c4_group_handle_new();
  if(!c4_group_handle_open_as_child(child_handle, parent_priv->handle,
                                    entry, FALSE, FALSE))
  {
    g_set_error(error, mape_group_error_quark, MAPE_GROUP_ERROR_OPEN,
                "Could not open '%s': %s", entry,
                c4_group_handle_get_error(child_handle));
    c4_group_handle_free(child_handle);
    return NULL;
  }
 
  child = mape_group_new();
  child_priv = MAPE_GROUP_PRIVATE(child);
  child_priv->handle = child_handle;
 
  return child;
}

References c4_group_handle_new(), c4_group_handle_open_as_child(), _MapeGroupPrivate::handle, mape_group_is_open(), mape_group_new(), mape_group_open(), MAPE_GROUP_PRIVATE, and MAPE_IS_GROUP.

Referenced by mape_mapgen_set_root_group().

Here is the call graph for this function:

Here is the caller graph for this function:

mape_group_rewind()

void mape_group_rewind

(

MapeGroup *

group

)

mape_group_rewind: @group: An open MapeGroup.

Resets the group's internal iterator. The next call to mape_group_get_next_entry() will return the first entry in the group again.

Definition at line 462 of file group.c.

{
  MapeGroupPrivate* priv;
 
  g_return_if_fail(MAPE_IS_GROUP(group));
  g_return_if_fail(mape_group_is_open(group));
 
  priv = MAPE_GROUP_PRIVATE(group);
 
#ifdef G_OS_WIN32
  if(priv->handle == NULL)
  {
    priv->drive = 1;
    return;
  }
#endif
 
  c4_group_handle_reset_search(priv->handle);
}

References c4_group_handle_reset_search(), _MapeGroupPrivate::handle, mape_group_is_open(), MAPE_GROUP_PRIVATE, and MAPE_IS_GROUP.

Referenced by mape_texture_map_load_textures().

Here is the call graph for this function:

Here is the caller graph for this function: