scpm_types.h File Reference

Some variable types used by SCPM. More...

#include <string>
#include <vector>
#include <unistd.h>

Include dependency graph for scpm_types.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	resource_group_t
	Variable type to represent a resource group. More...
struct	resource_entry_t
	Variable type to represent a resource entry of a resource group. More...
struct	resource_info_t
	variable type for resource information More...
struct	switch_info_t
	variable type for profile switch information More...
struct	scpm_status_t
	transport container for SCPM status information More...
struct	backup_info_t
	Helpers struct for backup funtions. More...

Enumerations
enum	save_mode_t { normal, save_all, patch_all }
	Enum varaible type. More...
enum	rebuild_mode_t { REBUILD_MODE_QUICK, REBUILD_MODE_RESOURCES_ONLY, REBUILD_MODE_DATA_ONLY, REBUILD_MODE_FULL }
	Rebuild mode enum. More...

Variables
char *	scpm_error
	Contains last error. More...
int	scpm_journal_abort_steps
const int	scpm_flag_force = 1
	force flag (deletes/overwrites silently data)
const int	scpm_flag_skip = 2
	skip flag (silently drops changes in profiles)
const int	scpm_flag_quiet = 4
	no user output
const int	scpm_flag_verbose = 8
	tell what's going on
const int	scpm_flag_hash = 16
	print progress bar when useful (using hash marks)
const int	scpm_flag_debug = 32
	log debug messages
const int	scpm_flag_boot = 64
	boot mode (does not call resource actions)
const int	scpm_flag_exit_on_warning = 128
	abort even on warnings
const int	scpm_flag_skip_load = 256
	skip loading of database
const int	scpm_flag_force_db = 512
	force loading of database even when versions do not match
const int	scpm_flag_read_only = 1024
const int	scpm_flag_wait_commit = 2048

Detailed Description

This file contains variable types used by SCPM and global variables.

Enumeration Type Documentation

enum save_mode_t

This is used in the switch_into_t struct. It can have the values normal (default), save_all, and patch_all. normal means the resource should get saved to the profile the user is about to leave and that's it. save_all means the resource should get saved to all existing profiles. patch_all means the current changes (and only the current) to the resource should be patched into all profiles.

enum rebuild_mode_t

Enumerator
REBUILD_MODE_QUICK	Removes obsolete resources and adds new ones.
REBUILD_MODE_RESOURCES_ONLY	Rebuilds only resources part of scdb.
REBUILD_MODE_DATA_ONLY	Rebuilds only data part of scdb (not yet supported)
REBUILD_MODE_FULL	Totally rebuilds scdb (not yet supported)

Variable Documentation

char * scpm_error

scpm_error is a character pointer containing the latest error. Usually, if SCPM encounters a fatal error, the current operation aborts and returns false (exceptions: SCPM::Active and SCPM::List). Afterwards you can investigate this global variable to find out the reason.