libpurple/purpleoptions.h

/*
 * Purple - Internet Messaging Library
 * Copyright (C) Pidgin Developers <devel@pidgin.im>
 *
 * Purple is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * 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 2 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 <https://www.gnu.org/licenses/>.
 */

#if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
# error "only <purple.h> may be included directly"
#endif

#ifndef PURPLE_OPTIONS_H
#define PURPLE_OPTIONS_H

/**
 * SECTION:purpleoptions
 * @section_id: libpurple-purpleoptions
 * @short_description: Command line argument integration
 * @title: Command Line Argument Integration
 *
 * The functions defined here are to help in handling command line options.
 */

#include <glib.h>

G_BEGIN_DECLS

/**
 * purple_get_option_group:
 *
 * Returns a #GOptionGroup for the commandline arguments recognized by
 * LibPurple.  You should add this option group to your #GOptionContext with
 * g_option_context_add_group(), if you are using g_option_context_parse() to
 * parse your commandline arguments.
 *
 * Returns: (transfer full): a #GOptionGroup for the commandline arguments
 *          recognized by LibPurple.
 */
GOptionGroup *purple_get_option_group(void);

G_END_DECLS

#endif /* PURPLE_OPTIONS_H */