Clarify docs.
[openssl.git] / engines / e_gmp_err.c
1 /* e_gmp_err.c */
2 /* ====================================================================
3  * Copyright (c) 1999-2005 The OpenSSL Project.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer. 
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in
14  *    the documentation and/or other materials provided with the
15  *    distribution.
16  *
17  * 3. All advertising materials mentioning features or use of this
18  *    software must display the following acknowledgment:
19  *    "This product includes software developed by the OpenSSL Project
20  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
21  *
22  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23  *    endorse or promote products derived from this software without
24  *    prior written permission. For written permission, please contact
25  *    openssl-core@OpenSSL.org.
26  *
27  * 5. Products derived from this software may not be called "OpenSSL"
28  *    nor may "OpenSSL" appear in their names without prior written
29  *    permission of the OpenSSL Project.
30  *
31  * 6. Redistributions of any form whatsoever must retain the following
32  *    acknowledgment:
33  *    "This product includes software developed by the OpenSSL Project
34  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
35  *
36  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
37  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
42  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
45  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
47  * OF THE POSSIBILITY OF SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This product includes cryptographic software written by Eric Young
51  * (eay@cryptsoft.com).  This product includes software written by Tim
52  * Hudson (tjh@cryptsoft.com).
53  *
54  */
55
56 /* NOTE: this file was auto generated by the mkerr.pl script: any changes
57  * made to it will be overwritten when the script next updates this file,
58  * only reason strings will be preserved.
59  */
60
61 #include <stdio.h>
62 #include <openssl/err.h>
63 #include "e_gmp_err.h"
64
65 /* BEGIN ERROR CODES */
66 #ifndef OPENSSL_NO_ERR
67
68 #define ERR_FUNC(func) ERR_PACK(0,func,0)
69 #define ERR_REASON(reason) ERR_PACK(0,0,reason)
70
71 static ERR_STRING_DATA GMP_str_functs[]=
72         {
73 {ERR_FUNC(GMP_F_E_GMP_CTRL),    "E_GMP_CTRL"},
74 {ERR_FUNC(GMP_F_E_GMP_RSA_MOD_EXP),     "E_GMP_RSA_MOD_EXP"},
75 {0,NULL}
76         };
77
78 static ERR_STRING_DATA GMP_str_reasons[]=
79         {
80 {ERR_REASON(GMP_R_CTRL_COMMAND_NOT_IMPLEMENTED),"ctrl command not implemented"},
81 {ERR_REASON(GMP_R_KEY_CONTEXT_ERROR)     ,"key context error"},
82 {ERR_REASON(GMP_R_MISSING_KEY_COMPONENTS),"missing key components"},
83 {0,NULL}
84         };
85
86 #endif
87
88 #ifdef GMP_LIB_NAME
89 static ERR_STRING_DATA GMP_lib_name[]=
90         {
91 {0      ,GMP_LIB_NAME},
92 {0,NULL}
93         };
94 #endif
95
96
97 static int GMP_lib_error_code=0;
98 static int GMP_error_init=1;
99
100 static void ERR_load_GMP_strings(void)
101         {
102         if (GMP_lib_error_code == 0)
103                 GMP_lib_error_code=ERR_get_next_error_library();
104
105         if (GMP_error_init)
106                 {
107                 GMP_error_init=0;
108 #ifndef OPENSSL_NO_ERR
109                 ERR_load_strings(GMP_lib_error_code,GMP_str_functs);
110                 ERR_load_strings(GMP_lib_error_code,GMP_str_reasons);
111 #endif
112
113 #ifdef GMP_LIB_NAME
114                 GMP_lib_name->error = ERR_PACK(GMP_lib_error_code,0,0);
115                 ERR_load_strings(0,GMP_lib_name);
116 #endif
117                 }
118         }
119
120 static void ERR_unload_GMP_strings(void)
121         {
122         if (GMP_error_init == 0)
123                 {
124 #ifndef OPENSSL_NO_ERR
125                 ERR_unload_strings(GMP_lib_error_code,GMP_str_functs);
126                 ERR_unload_strings(GMP_lib_error_code,GMP_str_reasons);
127 #endif
128
129 #ifdef GMP_LIB_NAME
130                 ERR_unload_strings(0,GMP_lib_name);
131 #endif
132                 GMP_error_init=1;
133                 }
134         }
135
136 static void ERR_GMP_error(int function, int reason, char *file, int line)
137         {
138         if (GMP_lib_error_code == 0)
139                 GMP_lib_error_code=ERR_get_next_error_library();
140         ERR_PUT_error(GMP_lib_error_code,function,reason,file,line);
141         }