Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
[datapipe] Unify naming. Contributes to JB#22475
Use "datapipe_"  prefix for all functions:

 datapipe_add_filter            <- append_filter_to_datapipe
 datapipe_add_input_trigger     <- append_input_trigger_to_datapipe
 datapipe_add_output_trigger    <- append_output_trigger_to_datapipe
 datapipe_exec_filters          <- execute_datapipe_filters
 datapipe_exec_full             <- execute_datapipe
 datapipe_exec_input_triggers   <- execute_datapipe_input_triggers
 datapipe_exec_output_triggers  <- execute_datapipe_output_triggers
 datapipe_free                  <- free_datapipe
 datapipe_init                  <- setup_datapipe
 datapipe_remove_filter         <- remove_filter_from_datapipe
 datapipe_remove_input_trigger  <- remove_input_trigger_from_datapipe
 datapipe_remove_output_trigger <- remove_output_trigger_from_datapipe

Datapipes that are used for solely for requesting state changes (i.e. do not
themselves have a state) have a verb in the name:

 display_state_request_pipe          <- display_state_req_pipe
 led_pattern_activate_pipe           (no change)
 led_pattern_deactivate_pipe         (no change)
 tklock_request_pipe                 <- tk_lock_pipe

Datapipes that are used solely process input events without having a
persistent state have "event" in the name:

 heartbeat_event_pipe                <- heartbeat_pipe
 ignore_incoming_call_event_pipe     <- ignore_incoming_call_pipe
 inactivity_event_pipe               <- device_inactive_event_pipe
 keypress_event_pipe                 <- keypress_pipe
 resume_detected_event_pipe          <- device_resumed_pipe
 touchscreen_event_pipe              <- touchscreen_pipe
 user_activity_event_pipe            <- user_activity_pipe

Datapipes dealing with brightness have "brightness" included in the name:

 display_brightness_pipe             (no change)
 key_backlight_brightness_pipe       <- key_backlight_pipe
 led_brightness_pipe                 (no change)
 lpm_brightness_pipe                 (no change)

Datapipes dealing with sensors have "sensor" in name and the one holding
unfiltered data is called "actual":

 lid_sensor_actual_pipe              <- lid_cover_sensor_pipe
 lid_sensor_filtered_pipe            <- lid_cover_policy_pipe
 lid_sensor_is_working_pipe          (no change)
 light_sensor_actual_pipe            <- ambient_light_sensor_pipe
 light_sensor_filtered_pipe          <- ambient_light_level_pipe
 light_sensor_poll_request_pipe      <- ambient_light_poll_pipe
 orientation_sensor_actual_pipe      <- orientation_sensor_pipe
 proximity_sensor_actual_pipe        <- proximity_sensor_pipe

Datapipes that have enumerated state reflect the enumeration type in
datapipe name:

 alarm_ui_state_pipe                 (no change)
 audio_route_pipe                    (no change)
 battery_status_pipe                 (no change)
 bluez_service_state_pipe            <- bluez_available_pipe
 call_state_pipe                     (no change)
 call_type_pipe                      (no change)
 camera_button_state_pipe            <- camera_button_pipe
 charger_state_pipe                  (no change)
 compositor_service_state_pipe       <- compositor_available_pipe
 devicelock_service_state_pipe       <- devicelock_available_pipe
 devicelock_state_pipe               <- device_lock_state_pipe
 display_state_curr_pipe             <- display_state_pipe
 display_state_next_pipe             (no change)
 dsme_service_state_pipe             <- dsme_available_pipe
 jack_sense_state_pipe               <- jack_sense_pipe
 keyboard_available_state_pipe       <- keyboard_available_pipe
 keyboard_slide_state_pipe           <- keyboard_slide_pipe
 lens_cover_state_pipe               <- lens_cover_pipe
 lipstick_service_state_pipe         <- lipstick_available_pipe
 lockkey_state_pipe                  <- lockkey_pipe
 ngfd_service_state_pipe             <- ngfd_available_pipe
 submode_pipe                        (no change)
 system_state_pipe                   (no change)
 thermal_state_pipe                  (no change)
 uiexception_type_pipe               <- exception_state_pipe
 usb_cable_state_pipe                <- usb_cable_pipe
 usbmoded_service_state_pipe         <- usbmoded_available_pipe

Datapipes that have boolean state should answer an
"is" question:

 device_inactive_pipe                <- device_inactive_state_pipe
 interaction_expected_pipe           (no change)
 keypad_grab_active_pipe             (no change)
 keypad_grab_wanted_pipe             (no change)
 master_radio_enabled_pipe           <- master_radio_pipe
 music_playback_ongoing_pipe         <- music_playback_pipe
 osupdate_running_pipe               <- update_mode_pipe
 packagekit_locked_pipe              (no change)
 power_saving_mode_active_pipe       <- power_saving_mode_pipe
 proximity_blanked_pipe              <- proximity_blank_pipe
 shutting_down_pipe                  (no change)
 touch_detected_pipe                 (no change)
 touch_grab_active_pipe              (no change)
 touch_grab_wanted_pipe              (no change)

Datapipes that have integer state should answer
and "what is" question:

 battery_level_pipe                  (no change)
 inactivity_delay_pipe               <- inactivity_timeout_pipe

Rename datapipe related callback functions and variables similarly as what
was done to datapipes.

Define submode bitmasks as submode_t enumeration instead of using
gint type and preprocessor constants. Change the value naming from
MCE_xxx_SUBMODE to MCE_SUBMODE_xxx.

Change call_type_t enumeration value naming from xxx_CALL to
CALL_TYPE_xxx.

Change system_state_t enumeration value naming from MCE_STATE_xxx
to MCE_SYSTEM_STATE_xxx.

Fix setting up of power_saving_mode_active_pipe, master_radio_enabled_pipe
and lens_cover_state_pipe so that initial values of appropriate type are
used.

Switch lockkey_state_pipe value from gboolean to key_state_t type.

Signed-off-by: Simo Piiroinen <simo.piiroinen@jollamobile.com>
  • Loading branch information
spiiroin committed Feb 28, 2018
1 parent 7af9f4c commit 5fadb87
Show file tree
Hide file tree
Showing 40 changed files with 2,506 additions and 2,472 deletions.
752 changes: 382 additions & 370 deletions datapipe.c

Large diffs are not rendered by default.

160 changes: 80 additions & 80 deletions datapipe.h
Expand Up @@ -24,20 +24,20 @@
#include <stdbool.h>
#include <glib.h>

/** Device lock states used in device_lock_state_pipe */
/** Device lock states used in devicelock_state_pipe */
typedef enum
{
/** Device lock is not active */
DEVICE_LOCK_UNLOCKED = 0,
DEVICELOCK_STATE_UNLOCKED = 0,

/** Device lock is active */
DEVICE_LOCK_LOCKED = 1,
DEVICELOCK_STATE_LOCKED = 1,

/** Initial startup value; from mce p.o.v. equals not active */
DEVICE_LOCK_UNDEFINED = 2,
} device_lock_state_t;
DEVICELOCK_STATE_UNDEFINED = 2,
} devicelock_state_t;

const char *device_lock_state_repr(device_lock_state_t state);
const char *devicelock_state_repr(devicelock_state_t state);

/**
* Datapipe structure
Expand Down Expand Up @@ -90,70 +90,70 @@ typedef enum {
/* Available datapipes */
extern datapipe_struct led_brightness_pipe;
extern datapipe_struct lpm_brightness_pipe;
extern datapipe_struct device_inactive_state_pipe;
extern datapipe_struct device_inactive_event_pipe;
extern datapipe_struct device_inactive_pipe;
extern datapipe_struct inactivity_event_pipe;
extern datapipe_struct led_pattern_activate_pipe;
extern datapipe_struct led_pattern_deactivate_pipe;
extern datapipe_struct device_resumed_pipe;
extern datapipe_struct user_activity_pipe;
extern datapipe_struct display_state_pipe;
extern datapipe_struct display_state_req_pipe;
extern datapipe_struct resume_detected_event_pipe;
extern datapipe_struct user_activity_event_pipe;
extern datapipe_struct display_state_curr_pipe;
extern datapipe_struct display_state_request_pipe;
extern datapipe_struct display_state_next_pipe;
extern datapipe_struct exception_state_pipe;
extern datapipe_struct uiexception_type_pipe;
extern datapipe_struct display_brightness_pipe;
extern datapipe_struct key_backlight_pipe;
extern datapipe_struct keypress_pipe;
extern datapipe_struct touchscreen_pipe;
extern datapipe_struct lockkey_pipe;
extern datapipe_struct keyboard_slide_pipe;
extern datapipe_struct keyboard_available_pipe;
extern datapipe_struct key_backlight_brightness_pipe;
extern datapipe_struct keypress_event_pipe;
extern datapipe_struct touchscreen_event_pipe;
extern datapipe_struct lockkey_state_pipe;
extern datapipe_struct keyboard_slide_state_pipe;
extern datapipe_struct keyboard_available_state_pipe;
extern datapipe_struct lid_sensor_is_working_pipe;
extern datapipe_struct lid_cover_sensor_pipe;
extern datapipe_struct lid_cover_policy_pipe;
extern datapipe_struct lens_cover_pipe;
extern datapipe_struct proximity_sensor_pipe;
extern datapipe_struct ambient_light_sensor_pipe;
extern datapipe_struct ambient_light_level_pipe;
extern datapipe_struct ambient_light_poll_pipe;
extern datapipe_struct orientation_sensor_pipe;
extern datapipe_struct lid_sensor_actual_pipe;
extern datapipe_struct lid_sensor_filtered_pipe;
extern datapipe_struct lens_cover_state_pipe;
extern datapipe_struct proximity_sensor_actual_pipe;
extern datapipe_struct light_sensor_actual_pipe;
extern datapipe_struct light_sensor_filtered_pipe;
extern datapipe_struct light_sensor_poll_request_pipe;
extern datapipe_struct orientation_sensor_actual_pipe;
extern datapipe_struct alarm_ui_state_pipe;
extern datapipe_struct system_state_pipe;
extern datapipe_struct master_radio_pipe;
extern datapipe_struct master_radio_enabled_pipe;
extern datapipe_struct submode_pipe;
extern datapipe_struct call_state_pipe;
extern datapipe_struct ignore_incoming_call_pipe;
extern datapipe_struct ignore_incoming_call_event_pipe;
extern datapipe_struct call_type_pipe;
extern datapipe_struct tk_lock_pipe;
extern datapipe_struct tklock_request_pipe;
extern datapipe_struct interaction_expected_pipe;
extern datapipe_struct charger_state_pipe;
extern datapipe_struct battery_status_pipe;
extern datapipe_struct battery_level_pipe;
extern datapipe_struct camera_button_pipe;
extern datapipe_struct inactivity_timeout_pipe;
extern datapipe_struct camera_button_state_pipe;
extern datapipe_struct inactivity_delay_pipe;
extern datapipe_struct audio_route_pipe;
extern datapipe_struct usb_cable_pipe;
extern datapipe_struct jack_sense_pipe;
extern datapipe_struct power_saving_mode_pipe;
extern datapipe_struct usb_cable_state_pipe;
extern datapipe_struct jack_sense_state_pipe;
extern datapipe_struct power_saving_mode_active_pipe;
extern datapipe_struct thermal_state_pipe;
extern datapipe_struct heartbeat_pipe;
extern datapipe_struct compositor_available_pipe;
extern datapipe_struct lipstick_available_pipe;
extern datapipe_struct devicelock_available_pipe;
extern datapipe_struct usbmoded_available_pipe;
extern datapipe_struct ngfd_available_pipe;
extern datapipe_struct dsme_available_pipe;
extern datapipe_struct bluez_available_pipe;
extern datapipe_struct heartbeat_event_pipe;
extern datapipe_struct compositor_service_state_pipe;
extern datapipe_struct lipstick_service_state_pipe;
extern datapipe_struct devicelock_service_state_pipe;
extern datapipe_struct usbmoded_service_state_pipe;
extern datapipe_struct ngfd_service_state_pipe;
extern datapipe_struct dsme_service_state_pipe;
extern datapipe_struct bluez_service_state_pipe;
extern datapipe_struct packagekit_locked_pipe;
extern datapipe_struct update_mode_pipe;
extern datapipe_struct osupdate_running_pipe;
extern datapipe_struct shutting_down_pipe;
extern datapipe_struct device_lock_state_pipe;
extern datapipe_struct devicelock_state_pipe;
extern datapipe_struct touch_detected_pipe;
extern datapipe_struct touch_grab_wanted_pipe;
extern datapipe_struct touch_grab_active_pipe;
extern datapipe_struct keypad_grab_wanted_pipe;
extern datapipe_struct keypad_grab_active_pipe;
extern datapipe_struct music_playback_pipe;
extern datapipe_struct proximity_blank_pipe;
extern datapipe_struct music_playback_ongoing_pipe;
extern datapipe_struct proximity_blanked_pipe;

/* Data retrieval */

Expand All @@ -173,43 +173,43 @@ extern datapipe_struct proximity_blank_pipe;
#define datapipe_get_gpointer(_datapipe) ((_datapipe).cached_data)

/* Datapipe execution */
void execute_datapipe_input_triggers(datapipe_struct *const datapipe,
gpointer const indata,
const data_source_t use_cache);
gconstpointer execute_datapipe_filters(datapipe_struct *const datapipe,
gpointer indata,
const data_source_t use_cache);
void execute_datapipe_output_triggers(const datapipe_struct *const datapipe,
gconstpointer indata,
const data_source_t use_cache);
gconstpointer execute_datapipe(datapipe_struct *const datapipe,
gpointer indata,
const data_source_t use_cache,
const caching_policy_t cache_indata);
void datapipe_exec_input_triggers(datapipe_struct *const datapipe,
gpointer const indata,
const data_source_t use_cache);
gconstpointer datapipe_exec_filters(datapipe_struct *const datapipe,
gpointer indata,
const data_source_t use_cache);
void datapipe_exec_output_triggers(const datapipe_struct *const datapipe,
gconstpointer indata,
const data_source_t use_cache);
gconstpointer datapipe_exec_full(datapipe_struct *const datapipe,
gpointer indata,
const data_source_t use_cache,
const caching_policy_t cache_indata);

/* Filters */
void append_filter_to_datapipe(datapipe_struct *const datapipe,
gpointer (*filter)(gpointer data));
void remove_filter_from_datapipe(datapipe_struct *const datapipe,
gpointer (*filter)(gpointer data));
void datapipe_add_filter(datapipe_struct *const datapipe,
gpointer (*filter)(gpointer data));
void datapipe_remove_filter(datapipe_struct *const datapipe,
gpointer (*filter)(gpointer data));

/* Input triggers */
void append_input_trigger_to_datapipe(datapipe_struct *const datapipe,
void (*trigger)(gconstpointer data));
void remove_input_trigger_from_datapipe(datapipe_struct *const datapipe,
void (*trigger)(gconstpointer data));
void datapipe_add_input_trigger(datapipe_struct *const datapipe,
void (*trigger)(gconstpointer data));
void datapipe_remove_input_trigger(datapipe_struct *const datapipe,
void (*trigger)(gconstpointer data));

/* Output triggers */
void append_output_trigger_to_datapipe(datapipe_struct *const datapipe,
void (*trigger)(gconstpointer data));
void remove_output_trigger_from_datapipe(datapipe_struct *const datapipe,
void (*trigger)(gconstpointer data));
void datapipe_add_output_trigger(datapipe_struct *const datapipe,
void (*trigger)(gconstpointer data));
void datapipe_remove_output_trigger(datapipe_struct *const datapipe,
void (*trigger)(gconstpointer data));

void setup_datapipe(datapipe_struct *const datapipe,
const read_only_policy_t read_only,
const cache_free_policy_t free_cache,
const gsize datasize, gpointer initial_data);
void free_datapipe(datapipe_struct *const datapipe);
void datapipe_init(datapipe_struct *const datapipe,
const read_only_policy_t read_only,
const cache_free_policy_t free_cache,
const gsize datasize, gpointer initial_data);
void datapipe_free(datapipe_struct *const datapipe);

/* Binding arrays */

Expand Down Expand Up @@ -267,9 +267,9 @@ void mce_datapipe_quit(void);
* because during already ongoing transition something \
* else might be already queued up and we want't the \
* last request to reach the queue to "win". */ \
execute_datapipe(&display_state_req_pipe,\
GINT_TO_POINTER(req_target),\
USE_INDATA, CACHE_OUTDATA);\
datapipe_exec_full(&display_state_request_pipe,\
GINT_TO_POINTER(req_target),\
USE_INDATA, CACHE_OUTDATA);\
} while(0)

#endif /* _DATAPIPE_H_ */

0 comments on commit 5fadb87

Please sign in to comment.