ui/profile.h

   1 /** @file
   2  *
   3  * Definitions for dialog box for profiles editing.
   4  * Stig Bjorlykke <stig@bjorlykke.org>, 2008
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  * SPDX-License-Identifier: GPL-2.0-or-later
  11  */
  12
  13 #ifndef __PROFILE_H__
  14 #define __PROFILE_H__
  15
  16 #include <glib.h>
  17
  18 #ifdef __cplusplus
  19 extern "C" {
  20 #endif /* __cplusplus */
  21
  22 /** @file
  23  * "Configuration Profiles" dialog box
  24  * @ingroup dialog_group
  25  */
  26
  27 #define PROF_STAT_DEFAULT  1
  28 #define PROF_STAT_EXISTS   2
  29 #define PROF_STAT_NEW      3
  30 #define PROF_STAT_CHANGED  4
  31 #define PROF_STAT_COPY     5
  32 #define PROF_STAT_IMPORT   6
  33
  34 typedef struct {
  35     char     *name;             /* profile name */
  36     char     *reference;        /* profile reference */
  37     int       status;
  38     bool      is_global;
  39     bool      from_global;
  40     bool      is_import;
  41     // Settings
  42     bool      prefs_changed;
  43     char     *auto_switch_filter;
  44 } profile_def;
  45
  46 /** @file
  47  * "Configuration Profiles" utility routines
  48  * @ingroup utility_group
  49  */
  50
  51 /** Initialize the profile list. Can be called more than once.
  52  */
  53 void init_profile_list(void);
  54
  55 /** User requested the "Configuration Profiles" popup menu.
  56  *
  57  * @param name Profile name
  58  * @param parent Parent profile name
  59  * @param status Current status
  60  * @param is_global Profile is in the global configuration directory
  61  * @param from_global Profile is copied from the global configuration directory
  62  * @param is_import Profile has been imported and no directory has to be created
  63  *
  64  * @return A pointer to the new profile list
  65  */
  66 GList *add_to_profile_list(const char *name, const char *parent, int status,
  67                            bool is_global, bool from_global, bool is_import);
  68
  69 /** Refresh the current (non-edited) profile list.
  70  */
  71 void copy_profile_list(void);
  72
  73 /** Clear out the profile list
  74  *
  75  * @param edit_list Remove edited entries
  76  */
  77 void empty_profile_list(bool edit_list);
  78
  79 /** Remove an entry from the profile list.
  80  *
  81  * @param fl_entry Profile list entry
  82  */
  83 void remove_from_profile_list(GList *fl_entry);
  84
  85 /** Current profile list
  86  *
  87  * @return The head of the current profile list
  88  */
  89 GList *current_profile_list(void);
  90
  91 /** Edited profile list
  92  *
  93  * @return The head of the edited profile list
  94  */
  95 GList * edited_profile_list(void);
  96
  97 /** Apply the changes in the edited profile list
  98  * @return NULL if the operation was successful or an error message otherwise.
  99  * The error message must be freed by the caller.
 100  */
 101 char *apply_profile_changes(void);
 102
 103 /** Given a profile name, return the name of its parent profile.
 104  *
 105  * @param profilename Child profile name
 106  *
 107  * @return Parent profile name
 108  */
 109 const char *get_profile_parent(const char *profilename);
 110
 111 /** Check the validity of a profile name.
 112  *
 113  * @param name Profile name
 114  * @return NULL if the name is valid or an error message otherwise.
 115  */
 116 char *profile_name_is_valid(const char *name);
 117
 118 /** Remove the current profile.
 119  *
 120  * @return true if the current profile exists and was successfully deleted
 121  * or false otherwise.
 122  */
 123 bool delete_current_profile(void);
 124
 125 #ifdef __cplusplus
 126 }
 127 #endif /* __cplusplus */
 128
 129 #endif /* __PROFILE_H__ */