State

Files
file	gnc-state.h
	Functions to load, save and get gui state.

Macros
#define	STATE_FILE_TOP   "Top"
#define	STATE_FILE_BOOK_GUID   "BookGuid"
#define	STATE_FILE_EXT   ".gcm"

Functions
GKeyFile *	gnc_state_load (const QofSession *session)
	Load the state from a state file on disk for the given session. More...
void	gnc_state_save (const QofSession *session)
	Save the state to a state file on disk for the given session. More...
GKeyFile *	gnc_state_get_current (void)
	Returns a pointer to the most recently loaded state. More...
gint	gnc_state_drop_sections_for (const gchar *partial_name)
	Drop all sections from the state file whose name contains partial_name. More...

Detailed Description

Function Documentation

gnc_state_drop_sections_for()

gint gnc_state_drop_sections_for

(

const gchar *

partial_name

)

Drop all sections from the state file whose name contains partial_name.

This function is meant to be called when an object is deleted for which state is kept. For example, when an account is deleted from GnuCash, all state sections that refer to it should get removed. In that case you can call this function with the account's guid as parameter.

Parameters

partial_name

a string to match in the section names for most objects in GnuCash that maintain state, this will be the object's guid

Returns

The number of successfully dropped sections.

Definition at line 260 of file gnc-state.c.

{
    gchar **groups;
    gint found_count = 0, dropped_count = 0;
    gsize i, num_groups;
    GError *error = NULL;

    if (!state_file)
    {
        PWARN ("No pre-existing state found, ignoring drop request");
        return 0;
    }

    ENTER("");

    groups = g_key_file_get_groups (state_file, &num_groups);
    for (i = 0; i < num_groups; i++)
    {
        if (g_strstr_len (groups[i], -1, partial_name))
        {
            DEBUG ("Section \"%s\" matches \"%s\", removing", groups[i], partial_name);
            found_count++;
            if (!g_key_file_remove_group (state_file, groups[i], &error))
            {
                PWARN ("Warning: unable to remove section %s.\n  %s",
                        groups[i],
                        error->message);
                g_error_free (error);
            }
            else
                dropped_count++;

        }
    }
    g_strfreev (groups);

    LEAVE("Found %i sections matching \"%s\", successfully removed %i",
            found_count, partial_name, dropped_count);
    return dropped_count;

}

gnc_state_get_current()

GKeyFile* gnc_state_get_current

(

void

)

Returns a pointer to the most recently loaded state.

Returns

A pointer to a GKeyFile that holds the current state information. If there is no current state, an empty state is returned (not NULL!). This pointer should never be freed, except when gnucash is exiting !

Definition at line 248 of file gnc-state.c.

{
    if (!state_file)
    {
        PINFO ("No pre-existing state found, creating new one");
        state_file = g_key_file_new ();
    }

    return state_file;

}

gnc_state_load()

GKeyFile* gnc_state_load

(

const QofSession *

session

)

Load the state from a state file on disk for the given session.

Parameters

session

The session to load the state for.

Returns

A pointer to a GKeyFile that holds the state information for the given session. If no state file was found an empty state is returned (not NULL!). This pointer should never be freed, except when gnucash is exiting !

Definition at line 202 of file gnc-state.c.

{
    /* Drop possible previous state_file first */
    if (state_file)
    {
        g_key_file_free (state_file);
        state_file = NULL;
    }

    gnc_state_set_base (session);

    if (state_file_name_pre_241)
        state_file = gnc_key_file_load_from_file (state_file_name_pre_241,
                     TRUE, TRUE, NULL);
    else if (state_file_name)
        state_file = gnc_key_file_load_from_file (state_file_name,
                     TRUE, TRUE, NULL);

    return gnc_state_get_current ();
}

gnc_state_save()

void gnc_state_save

(

const QofSession *

session

)

Save the state to a state file on disk for the given session.

Parameters

session

The session to save the state for.

Definition at line 223 of file gnc-state.c.

{
    GError *error = NULL;

    if (!strlen (qof_session_get_url(session)))
    {
        DEBUG("No file associated with session - skip state saving");
        return;
    }

    gnc_state_set_base (session);

    /* Write it all out to disk */
    if (state_file_name)
        gnc_key_file_save_to_file(state_file_name, state_file, &error);
    else
        PWARN ("No state file name set, can't save state");

    if (error)
    {
        PERR ("Error: Cannot open state file %s", error->message);
        g_error_free (error);
    }
}