archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity
This repository has been archived on 2023-10-09. You can view files and clone it, but cannot push or open issues or pull requests.
Files
749567e0b2c264c2c27a85feab611bee976f1527
blender-archive/source/blender/blenlib/BLI_args.h

75 lines
2.3 KiB
C++
Raw Normal View History

doxygen: add blenlib under core as module.
2011-02-18 13:58:08 +00:00
/*
New argument parsing library supporting multiple passes, case sensitive and insensitive arguments, default handlers and other features that were hacked in the previous ugly switch system. Very simpler system for adding new arguments, easier to see conflicts and no more replication between BG and non BG mode arguments. I've tested pretty much everything except GE options (-g options), but some small bugs could have sneaked in.
2010-02-01 01:43:31 +00:00
* 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, write to the Free Software Foundation,
correct fsf address
2010-02-12 13:34:04 +00:00
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
New argument parsing library supporting multiple passes, case sensitive and insensitive arguments, default handlers and other features that were hacked in the previous ugly switch system. Very simpler system for adding new arguments, easier to see conflicts and no more replication between BG and non BG mode arguments. I've tested pretty much everything except GE options (-g options), but some small bugs could have sneaked in.
2010-02-01 01:43:31 +00:00
*
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved.
*/
unify include guard defines, __$FILENAME__ without the underscores these clogged up the namespace for autocompleation which was annoying.
2012-02-17 18:59:41 +00:00
#ifndef __BLI_ARGS_H__
#define __BLI_ARGS_H__
New argument parsing library supporting multiple passes, case sensitive and insensitive arguments, default handlers and other features that were hacked in the previous ugly switch system. Very simpler system for adding new arguments, easier to see conflicts and no more replication between BG and non BG mode arguments. I've tested pretty much everything except GE options (-g options), but some small bugs could have sneaked in.
2010-02-01 01:43:31 +00:00
doxygen: add newline after \file While \file doesn't need an argument, it can't have another doxy command after it.
2019-02-18 08:08:12 +11:00
/** \file
* \ingroup bli
* \brief A general argument parsing module.
doxygen: add blenlib under core as module.
2011-02-18 13:58:08 +00:00
*/
New argument parsing library supporting multiple passes, case sensitive and insensitive arguments, default handlers and other features that were hacked in the previous ugly switch system. Very simpler system for adding new arguments, easier to see conflicts and no more replication between BG and non BG mode arguments. I've tested pretty much everything except GE options (-g options), but some small bugs could have sneaked in.
2010-02-01 01:43:31 +00:00
struct bArgs;
typedef struct bArgs bArgs;
style cleanup
2012-07-04 20:47:12 +00:00
/**
* Returns the number of extra arguments consumed by the function.
* - 0 is normal value,
* - -1 stops parsing arguments, other negative indicates skip
*/
code cleanup: header cleanup and remove some duplicate defines.
2012-05-12 20:39:39 +00:00
typedef int (*BA_ArgCallback)(int argc, const char **argv, void *data);
New argument parsing library supporting multiple passes, case sensitive and insensitive arguments, default handlers and other features that were hacked in the previous ugly switch system. Very simpler system for adding new arguments, easier to see conflicts and no more replication between BG and non BG mode arguments. I've tested pretty much everything except GE options (-g options), but some small bugs could have sneaked in.
2010-02-01 01:43:31 +00:00
set main() argv functions to be const char * also set minimum cmake version to 2.8
2011-02-19 12:05:20 +00:00
struct bArgs *BLI_argsInit(int argc, const char **argv);
New argument parsing library supporting multiple passes, case sensitive and insensitive arguments, default handlers and other features that were hacked in the previous ugly switch system. Very simpler system for adding new arguments, easier to see conflicts and no more replication between BG and non BG mode arguments. I've tested pretty much everything except GE options (-g options), but some small bugs could have sneaked in.
2010-02-01 01:43:31 +00:00
void BLI_argsFree(struct bArgs *ba);
style cleanup
2012-07-04 20:47:12 +00:00
/**
* Pass starts at 1, -1 means valid all the time
BLI_args cleanup Adding documentation strings in argument data. --help is auto generated (options not manually categorized end up in the "others" section at the bottom)
2010-05-24 18:53:45 +00:00
* short_arg or long_arg can be null to specify no short or long versions
style cleanup
2012-07-04 20:47:12 +00:00
*/
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
void BLI_argsAdd(struct bArgs *ba,
int pass,
const char *short_arg,
const char *long_arg,
const char *doc,
BA_ArgCallback cb,
void *data);
style cleanup
2012-07-04 20:47:12 +00:00
/**
* Short_case and long_case specify if those arguments are case specific
*/
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
void BLI_argsAddCase(struct bArgs *ba,
int pass,
const char *short_arg,
int short_case,
const char *long_arg,
int long_case,
const char *doc,
BA_ArgCallback cb,
void *data);
New argument parsing library supporting multiple passes, case sensitive and insensitive arguments, default handlers and other features that were hacked in the previous ugly switch system. Very simpler system for adding new arguments, easier to see conflicts and no more replication between BG and non BG mode arguments. I've tested pretty much everything except GE options (-g options), but some small bugs could have sneaked in.
2010-02-01 01:43:31 +00:00
void BLI_argsParse(struct bArgs *ba, int pass, BA_ArgCallback default_cb, void *data);
Enabled GCC -Wwrite-strings warning for CMake and replaced many 'char's for 'const char's,. Only one functional change where Transform orientations passed "" to BIF_createTransformOrientation() which could then have the value written into.
2010-12-03 17:05:21 +00:00
void BLI_argsPrintArgDoc(struct bArgs *ba, const char *arg);
BLI_args cleanup Adding documentation strings in argument data. --help is auto generated (options not manually categorized end up in the "others" section at the bottom)
2010-05-24 18:53:45 +00:00
void BLI_argsPrintOtherDoc(struct bArgs *ba);
New argument parsing library supporting multiple passes, case sensitive and insensitive arguments, default handlers and other features that were hacked in the previous ugly switch system. Very simpler system for adding new arguments, easier to see conflicts and no more replication between BG and non BG mode arguments. I've tested pretty much everything except GE options (-g options), but some small bugs could have sneaked in.
2010-02-01 01:43:31 +00:00
void BLI_argsPrint(struct bArgs *ba);
set main() argv functions to be const char * also set minimum cmake version to 2.8
2011-02-19 12:05:20 +00:00
const char **BLI_argsArgv(struct bArgs *ba);
New argument parsing library supporting multiple passes, case sensitive and insensitive arguments, default handlers and other features that were hacked in the previous ugly switch system. Very simpler system for adding new arguments, easier to see conflicts and no more replication between BG and non BG mode arguments. I've tested pretty much everything except GE options (-g options), but some small bugs could have sneaked in.
2010-02-01 01:43:31 +00:00
#endif
Copy Permalink