tools/purge/conffile.hh

   1 /*
   2  * Copyright (C) 1996-2019 The Squid Software Foundation and contributors
   3  *
   4  * Squid software is distributed under GPLv2+ license and includes
   5  * contributions from numerous individuals and organizations.
   6  * Please see the COPYING and CONTRIBUTORS files for details.
   7  */
   8
   9 // Author:  Jens-S. V?ckler <voeckler@rvs.uni-hannover.de>
  10 //
  11 // File:    conffile.hh
  12 //          Fri Sep 15 2000
  13 //
  14 // (c) 2000 Lehrgebiet Rechnernetze und Verteilte Systeme
  15 //          Universit?t Hannover, Germany
  16 //
  17 // Permission to use, copy, modify, distribute, and sell this software
  18 // and its documentation for any purpose is hereby granted without fee,
  19 // provided that (i) the above copyright notices and this permission
  20 // notice appear in all copies of the software and related documentation,
  21 // and (ii) the names of the Lehrgebiet Rechnernetze und Verteilte
  22 // Systeme and the University of Hannover may not be used in any
  23 // advertising or publicity relating to the software without the
  24 // specific, prior written permission of Lehrgebiet Rechnernetze und
  25 // Verteilte Systeme and the University of Hannover.
  26 //
  27 // THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
  28 // EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  29 // WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  30 //
  31 // IN NO EVENT SHALL THE LEHRGEBIET RECHNERNETZE UND VERTEILTE SYSTEME OR
  32 // THE UNIVERSITY OF HANNOVER BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
  33 // INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
  34 // WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR NOT
  35 // ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF LIABILITY,
  36 // ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  37 // SOFTWARE.
  38 //
  39 // Revision 1.2  2000/09/21 10:17:17  cached
  40 // namespace std:: needed for Sun WS compiler.
  41 //
  42 // Revision 1.1  2000/09/21 09:45:14  voeckler
  43 // Initial revision
  44 //
  45 //
  46 #ifndef _CONFFILE_HH
  47 #define _CONFFILE_HH
  48
  49 #if !defined(__cplusplus)
  50 #ifndef HAVE_BOOL
  51 #define HAVE_BOOL
  52 typedef int bool;
  53 #define false 0
  54 #define true  1
  55 #endif
  56 #endif /* __cplusplus */
  57
  58 #include <vector>
  59
  60 struct CacheDir {
  61   enum CacheDirType { CDT_NONE, CDT_UFS, CDT_AUFS, CDT_DISKD, CDT_OTHER };
  62
  63   const char*  base;
  64   CacheDirType type;
  65   size_t       size;
  66   unsigned     level[2];
  67 };
  68
  69 typedef std::vector<CacheDir> CacheDirVector;
  70
  71 int
  72 readConfigFile( CacheDirVector& cachedir,
  73                 const char* fn,
  74                 FILE* debug = 0 );
  75   // purpose: read squid.conf file and extract cache_dir entries
  76   // paramtr: cachedir (OUT): vector with an entry for each cache_dir found
  77   //          fn (IN): file name of squid.conf to use
  78   //          debug (IO): if not null, place debug information there
  79   // returns: number of entries, or negative to warn of errors
  80
  81 #endif // _CONFFILE_HH