mirrors/sway
1
0
Fork 0
mirror of https://github.com/swaywm/sway.git synced 2025-12-16 08:56:32 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add some documentation comments

Browse source 
This is mostly setting a precedent, I hope that others will continue to
write docs for more headers.

Ref #218
This commit is contained in:
Drew DeVault 2015-11-08 12:06:12 -05:00
parent d3de6af6c2
commit edb3e4b5ab
3 changed files with 224 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

36
include/config.h
View file

@ -8,22 +8,36 @@
#include "layout.h"
#include "container.h"
/**
* Describes a variable created via the `set` command.
*/
struct sway_variable {
char *name;
char *value;
};
/**
* A key binding and an associated command.
*/
struct sway_binding {
list_t *keys;
uint32_t modifiers;
char *command;
};
/**
* A "mode" of keybindings created via the `mode` command.
*/
struct sway_mode {
char *name;
list_t *bindings;
};
/**
* Size and position configuration for a particular output.
*
* This is set via the `output` command.
*/
struct output_config {
char *name;
bool enabled;
@ -31,11 +45,19 @@ struct output_config {
int x, y;
};
/**
* Maps a workspace name to an output name.
*
* Set via `workspace <x> output <y>`
*/
struct workspace_output {
char *output;
char *workspace;
};
/**
* The configuration struct. The result of loading a config file.
*/
struct sway_config {
list_t *symbols;
list_t *modes;
@ -62,12 +84,24 @@ struct sway_config {
int gaps_outer;
};
/**
* Loads the config from the given path.
*/
bool load_config(const char *file);
/** Reads the config from the given FILE.
*/
bool read_config(FILE *file, bool is_active);
/**
* Does variable replacement for a string based on the config's currently loaded variables.
*/
char *do_var_replacement(char *str);
// Setup output container by applying given config
/** Sets up a WLC output handle based on a given output_config.
*/
void apply_output_config(struct output_config *oc, swayc_t *output);
/**
* Global config singleton.
*/
extern struct sway_config *config;
#endif