tools/trace-malloc/formdata.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is formdata.h code, released
  17  * May 9, 2002.
  18  *
  19  * The Initial Developer of the Original Code is
  20  * Netscape Communications Corporation.
  21  * Portions created by the Initial Developer are Copyright (C) 2002
  22  * the Initial Developer. All Rights Reserved.
  23  *
  24  * Contributor(s):
  25  *   Garrett Arch Blythe, 09-May-2002
  26  *
  27  * Alternatively, the contents of this file may be used under the terms of
  28  * either the GNU General Public License Version 2 or later (the "GPL"), or
  29  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  30  * in which case the provisions of the GPL or the LGPL are applicable instead
  31  * of those above. If you wish to allow use of your version of this file only
  32  * under the terms of either the GPL or the LGPL, and not to allow others to
  33  * use your version of this file under the terms of the MPL, indicate your
  34  * decision by deleting the provisions above and replace them with the notice
  35  * and other provisions required by the GPL or the LGPL. If you do not delete
  36  * the provisions above, a recipient may use your version of this file under
  37  * the terms of any one of the MPL, the GPL or the LGPL.
  38  *
  39  * ***** END LICENSE BLOCK ***** */
  40
  41 #if !defined(__formdata_H__)
  42 #define __formdata_H__
  43
  44 /*
  45 **  formdata.h
  46 **
  47 **  Play (quick and dirty) utility API to parse up form get data into
  48 **      name value pairs.
  49 */
  50
  51 typedef struct __struct_FormData
  52 /*
  53 **  Structure to hold the breakdown of any form data.
  54 **
  55 **  mNArray     Each form datum is a name value pair.
  56 **              This array holds the names.
  57 **              You can find the corresponding value at the same index in
  58 **                  mVArray.
  59 **              Never NULL, but perhpas an empty string.
  60 **  mVArray     Each form datum is a name value pair.
  61 **              This array holds the values.
  62 **              You can find the corresponding name at the same index in
  63 **                  mNArray.
  64 **              Never NULL, but perhpas an empty string.
  65 **  mNVCount    Count of array items in both mNArray and mVArray.
  66 **  mStorage    Should be ignored by users of this API.
  67 **              In reality holds the duped and decoded form data.
  68 */
  69 {
  70     char** mNArray;
  71     char** mVArray;
  72     unsigned mNVCount;
  73     char* mStorage;
  74 }
  75 FormData;
  76
  77 FormData* FormData_Create(const char* inFormData)
  78 /*
  79 **  Take a contiguous string of form data, possibly hex encoded, and return
  80 **      the name value pairs parsed up and decoded.
  81 **  A caller of this routine should call FormData_Destroy at some point.
  82 **
  83 **  inFormData          The form data to parse up and decode.
  84 **  returns FormData*   The result of our effort.
  85 **                      This should be passed to FormData_Destroy at some
  86 **                          point of the memory will be leaked.
  87 */
  88 ;
  89
  90 void FormData_Destroy(FormData* inDestroy)
  91 /*
  92 **  Release to the heap the structure previously created via FormData_Create.
  93 **
  94 **  inDestroy   The object to free off.
  95 */
  96 ;
  97
  98 #endif /* __formdata_H__ */