aboutsummaryrefslogtreecommitdiffstats
path: root/src/cg-base.h
blob: 13667b707fe0d58ecb52b583b0c9c731a5b08098 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
/**
 * cg-tools -- Cooperative gamma-enabled tools
 * Copyright (C) 2016  Mattias Andrée (maandree@kth.se)
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#include <libcoopgamma.h>



/**
 * Information (except asynchronous call context)
 * required to update the gamma ramps on a CRTC.
 */
typedef struct filter_update
{
  /**
   * The filter to update
   * 
   * `.filter.crtc` and `.filter.priority`
   * are preconfigured
   */
  libcoopgamma_filter_t filter;
  
  /**
   * Has the update been synchronised?
   */
  int synced;
  
  /**
   * Did the update fail?
   */
  int failed;
  
  /**
   * Error description if `.failed` is true
   */
  libcoopgamma_error_t error;
  
  /**
   * If zero, the ramps in `.filter` shall
   * neither be modified nor freed.
   */
  int master;
  
  /**
   * 0-terminated list of elements in
   * `.crtc_updates` which shares gamma
   * ramps with this instance
   * 
   * This will only be set if `.master`
   * is true.
   */
  size_t* slaves;
  
} filter_update_t;



/**
 * The process's name
 */
extern const char* argv0;

/**
 * The libcoopgamma context
 */
extern libcoopgamma_context_t cg;

/**
 * The names of the selected CRTC:s
 */
extern char** crtcs;

/**
 * Gamma ramp updates for each CRTC
 */
extern filter_update_t* crtc_updates;

/**
 * CRTC and monitor information about
 * each selected CRTC and connect monitor
 */
extern libcoopgamma_crtc_info_t* crtc_info;

/**
 * The number of selected CRTC:s
 */
extern size_t crtcs_n;



/**
 * The default filter priority for the program
 */
extern const int64_t default_priority;



/**
 * Make elements in `crtc_updates` slaves where appropriate
 * 
 * @return  Zero on success, -1 on error
 */
int make_slaves(void);



/**
 * Print usage information and exit
 */
#if defined(__GNUC__)
__attribute__((__noreturn__))
#endif
extern void usage(void);

/**
 * Handle a command line option
 * 
 * @param   opt  The option, it is a NUL-terminate two-character
 *               string starting with either '-' or '+', if the
 *               argument is not recognised, call `usage`. This
 *               string will not be "-m", "-s", or "-c".
 * @param   arg  The argument associated with `opt`,
 *               `NULL` there is no next argument, if this
 *               parameter is `NULL` but needed, call `usage`
 * @return       0 if `arg` was not used,
 *               1 if `arg` was used,
 *               -1 on error
 */
#if defined(__GNUC__)
__attribute__((__nonnull__(1)))
#endif
extern int handle_opt(char* opt, char* arg);

/**
 * This function is called after the last
 * call to `handle_opt`
 * 
 * @param   argc    The number of unparsed arguments
 * @param   argv    `NULL` terminated list of unparsed arguments
 * @param   method  The argument associated with the "-m" option
 * @param   site    The argument associated with the "-s" option
 * @param   crtcs   The arguments associated with the "-c" options, `NULL`-terminated
 * @return          Zero on success, -1 on error
 */
#if defined(__GNUC__)
__attribute__((__nonnull__(2)))
#endif
extern int handle_args(int argc, char* argv[], char* method, char* site, char** crtcs);

/**
 * The main function for the program-specific code
 * 
 * @return  0: Success
 *          -1: Error, `errno` set
 *          -2: Error, `cg.error` set
 *          -3: Error, message already printed
 */
extern int start(void);