C конфигурация API

Каким образом обновлять вызов функции во всех местах - это хорошо ? Конечно, вам следует перестроить все с новыми обновленными заголовками, но в идеале вам нужно будет вносить как можно меньше изменений в код при каждом изменении конфигурации.

Длинные списки параметров не читаются, особенно если это список логических значений. Каждый раз, когда вы обращаетесь к вызову функции, который выглядит следующим образом:

    set_diagnostic_email_config("bla@foo.com", 0, 1, 0, 1, 0, 1, 0, 0, 0);

вы должны заглянуть в документацию, чтобы увидеть, для чего подходит этот шаблон цифр. И если вы используете эту функцию, вы хотите использовать в большинстве случаев с некоторыми разумными настройками по умолчанию, т.е. вы в конечном итоге копируете эту строку откуда-то еще.

Если у вас есть только логические значения, я бы использовал флаги, которые вы можете комбинировать с оператором ИЛИ. Вот возможный пример:

   typedef enum {
       FLAG_DEFAULT = 0,
       FLAG_INCLUDE_TIMESTAMP = 0x1,
       FLAG_SEND_FOR_CRASHES = 0x2,
       FLAG_SEND_DAILY_STATUS = 0x4,
       FLAG_SEND_ON_EVENT1 = 0x8
    } Email_Flags;

    int set_diagnostic_email_config(const char *address, unsigned int flags);

Теперь вы можете вызывать функцию следующим образом:

  set_diagnostic_email_config (" bla@foo.com ", FLAG_SEND_DAILY_STATUS | FLAG_SEND_ON_EVENT1);

Этот код легко читать, вам не нужно знать все варианты, чтобы понять его. И этот код легко написать, потому что порядок «параметров» (на самом деле порядок флагов) не важен. И эту функцию легко расширить, вы можете просто добавить больше флагов, скажем FLAG_SEND_ON_EVENT2 , и вам не нужно изменять вызов функции, если вы хотите изменить ее поведение.

Я бы использовал следующий способ, который является расширением вашего пути.

struct INFO
{
    char *to_address;
    bool include_timestamp;
    bool send_for_crashes;
    bool send_daily_status;
    bool send_on_event1;
    bool send_on_event2;
};

struct INFO *createINFO()
{
    // initialize to defaults.

    // return a pointer to the new created struct.
}

void include_timestamp(struct INFO *info, bool vInclude_timestamp)
{
    // set the field.
}

// add the required setters...

void destroyINFO(struct INFO *info)
{
    // destroy the struct.
}

Таким образом, вы можете добавлять сеттеры по запросу, когда вы добавляете новое поле. Не позволяя пользователю вмешиваться в саму структуру.

Подход «многочисленные параметры» имеет большой недостаток, заключающийся в том, что вам нужно изменять много кода каждый раз, когда вводится новый параметр, просто ради передачи этого параметра вниз по стеку вызовов. Со структурой вам нужно только изменить места, которые фактически используют параметры. Необходимость часто изменять тонны кода сама по себе может вызвать установку ошибок, что перевесит преимущества проверки всех присутствующих параметров во время компиляции.

Я бы использовал

int set_diagnostic_email_config( char *to_address,
                                 bool include_timestamp,
                                 int event_type ) {
    switch (event_type) {
        case 1:
        ...
    }
}

или

int set_diagnostic_email_config( char *to_address,
                                 bool include_timestamp,
                                 int event_type, void *details )

. Наличие event_type в качестве целого числа означает, что вы можете добавить новое событие без изменения подписи. Дополнительный void * дает дополнительную структуру для каждого типа события.

Если вы используете struct , изменения в ней не всегда могут быть двоично совместимы.