TODO::documentation: add entries for tutorial and moving generated doc files to new...
[Ale.git] / ui / unsupported.h
blobeb477ee4f37e218a30b9c20407c0afb1f15125f4
1 // Copyright 2004 David Hilvert <dhilvert@auricle.dyndns.org>,
2 // <dhilvert@ugcs.caltech.edu>
4 /* This file is part of the Anti-Lamenessing Engine.
6 The Anti-Lamenessing Engine is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 The Anti-Lamenessing Engine is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with the Anti-Lamenessing Engine; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #ifndef __unsupported_h__
22 #define __unsupported_h__
25 * Information about unsupported features.
27 class unsupported {
28 public:
30 * Describe a feature that is unsupported for now.
32 static void fornow(const char *description) {
33 fprintf(stderr, "\n\n");
34 fprintf(stderr, "The following feature is currently unsupported:\n\n");
35 fprintf(stderr, description);
36 fprintf(stderr, "\n\n");
37 #if 0
38 fprintf(stderr, "For more information, see http://auricle.dyndns.org/ALE/unsupported/currently/\n\n");
39 #endif
41 exit(1);
45 * Describe an option that is undocumented.
47 static void undocumented(const char *description) {
48 fprintf(stderr, "\n\n");
49 fprintf(stderr, "Warning: %s is undocumented.\n", description);
53 * Describe an option that is no longer supported.
55 static void discontinued(const char *description, const char *alternative = NULL, const char *alternative2 = NULL) {
56 fprintf(stderr, "\n\n");
57 fprintf(stderr, "Error: %s is no longer supported.\n", description);
59 if (alternative && alternative2) {
60 fprintf(stderr, " Use either: %s\n", alternative);
61 fprintf(stderr, " or: %s\n", alternative2);
62 } else if (alternative)
63 fprintf(stderr, " Use: %s\n", alternative);
65 fprintf(stderr, "\n");
67 exit(1);
71 #endif