textgen.h
上传用户:lyxiangda
上传日期:2007-01-12
资源大小:3042k
文件大小:5k
源码类别:

CA认证

开发平台:

WINDOWS

  1. /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
  2. /*
  3.  * The contents of this file are subject to the Mozilla Public
  4.  * License Version 1.1 (the "License"); you may not use this file
  5.  * except in compliance with the License. You may obtain a copy of
  6.  * the License at http://www.mozilla.org/MPL/
  7.  * 
  8.  * Software distributed under the License is distributed on an "AS
  9.  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  10.  * implied. See the License for the specific language governing
  11.  * rights and limitations under the License.
  12.  * 
  13.  * The Original Code is the Netscape security libraries.
  14.  * 
  15.  * The Initial Developer of the Original Code is Netscape
  16.  * Communications Corporation.  Portions created by Netscape are 
  17.  * Copyright (C) 1994-2000 Netscape Communications Corporation.  All
  18.  * Rights Reserved.
  19.  * 
  20.  * Contributor(s):
  21.  * 
  22.  * Alternatively, the contents of this file may be used under the
  23.  * terms of the GNU General Public License Version 2 or later (the
  24.  * "GPL"), in which case the provisions of the GPL are applicable 
  25.  * instead of those above.  If you wish to allow use of your 
  26.  * version of this file only under the terms of the GPL and not to
  27.  * allow others to use your version of this file under the MPL,
  28.  * indicate your decision by deleting the provisions above and
  29.  * replace them with the notice and other provisions required by
  30.  * the GPL.  If you do not delete the provisions above, a recipient
  31.  * may use your version of this file under either the MPL or the
  32.  * GPL.
  33.  */
  34. /*
  35.     Include file for libnls related utilities. Separated because there
  36.     are a lot of headers for libnls, and only those objects which override
  37.     the default Print function (see resource.h) should be including
  38.     these files.
  39.     mwelch - 1999 January
  40.  */
  41. #ifndef __textgen_h__
  42. #define __textgen_h__
  43. #include "nlsutil.h"
  44. #include "minihttp.h"
  45. #include "resource.h"
  46. #include "ctrlconn.h"
  47. /* Indices for the resource bundles. 
  48.    Keep in sync with (resBundleNames) below. */
  49. typedef enum
  50. {
  51.     SSM_RESBNDL_TEXT = (PRInt32) 0,
  52.     SSM_RESBNDL_UI,
  53.     SSM_RESBNDL_BIN,
  54.     SSM_RESBNDL_DOC,
  55.     SSM_RESBNDL_COUNT
  56. } SSMResourceBundleIndex;
  57. extern char *resBundleNames[];
  58. /* Text generator state, used by keyword handlers */
  59. typedef struct SSMTextGenContext
  60. {
  61.     struct SSMTextGenContext *m_caller;  /* who called us, if at all */
  62.     HTTPRequest *             m_request; /* the HTTP request being processed */
  63.     char*                     m_keyword; /* the keywd by which we are called */
  64.     SSMCollection *           m_params;  /* params to this keyword */
  65.     char*                     m_result;  /* where we store the result */
  66. } SSMTextGenContext;
  67. /* Create/destroy a textgen context. */
  68. SSMStatus SSMTextGen_NewContext(SSMTextGenContext *caller, /* can be NULL */
  69.                                 HTTPRequest *req,
  70.                                 char *keyword,
  71.                                 char **params,
  72.                                 SSMTextGenContext **result);
  73. /* Create a top-level textgen context. */
  74. SSMStatus SSMTextGen_NewTopLevelContext(HTTPRequest *req,
  75.                                         SSMTextGenContext **result);
  76. void SSMTextGen_DestroyContext(SSMTextGenContext *victim);
  77. /* Helper routines used with a TextGenContext */
  78. SSMResource *SSMTextGen_GetTargetObject(SSMTextGenContext *cx);
  79. SSMControlConnection *SSMTextGen_GetControlConnection(SSMTextGenContext *cx);
  80. /* 
  81.    Top level routine called by non-NLS-using parts of Cartman. 
  82.    Retrieves a string, expands it, then formats it according to the
  83.    _Print method of the target object. 
  84. */
  85. SSMStatus SSM_GetUTF8Text(SSMTextGenContext *cx,  /* can be NULL */
  86.                           const char *key, 
  87.                           char **resultText);
  88. /* Get a numeric parameter from the properties file. */
  89. SSMStatus SSM_GetNumber(SSMTextGenContext *cx, char *key, PRInt32 *param);
  90. /* Just gets and expands a string. Can pass NULL for (res). */
  91. SSMStatus SSM_GetAndExpandText(SSMTextGenContext *cx, 
  92.                                const char *key, char **result);
  93. SSMStatus SSM_GetAndExpandTextKeyedByString(SSMTextGenContext *cx,
  94.                                             const char *key, 
  95.                                             char **result);
  96. /* Keyword processing function. */
  97. typedef SSMStatus (*KeywordHandlerFunc)(SSMTextGenContext *cx);
  98. SSMStatus SSM_HelloKeywordHandler(SSMTextGenContext *cx);
  99. /* Register a keyword callback. */
  100. SSMStatus SSM_RegisterKeywordHandler(char *keyword, 
  101.                                      KeywordHandlerFunc func);
  102. /* Perform NLS-specific initialization. (dataDirectory) contains the path
  103.    of the directory containing the "conv" folder with conversion libraries
  104.    for the current locale. */
  105. void SSM_InitNLS(char *dataDirectory);
  106. /* Given a key and a context, cycle through resource bundles until
  107.    we find a match for the desired key. */
  108. SSMStatus
  109. SSM_FindUTF8StringInBundles(SSMTextGenContext *cx,
  110.                             const char *key,
  111.                             char **utf8result);
  112. SSMStatus SSMTextGen_SubstituteString(SSMTextGenContext *cx, 
  113.                                       char *str, 
  114.                                       char **result);
  115. SSMStatus 
  116. SSM_WarnPKCS12Incompatibility(SSMTextGenContext *cx);
  117. SSMStatus
  118. SSM_PassVariable(SSMTextGenContext *cx);
  119. #endif