CGI.h

Go to the documentation of this file.

/* -*- c++ -*-
 * $Id: CGI.h,v 1.33 2006/05/16 20:06:34 brook Exp $
 */

/*
 * ClearSilver++ Software License.
 *
 * Copyright (c) 2005,2006 Brook Milligan <brook@nmsu.edu>
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials provided
 *    with the distribution.
 * 3. The name of the author may not be used to endorse or promote
 *    products derived from this software without specific prior
 *    written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef CGI_h_
#define CGI_h_ 1

#include <iosfwd>
#include <string>
#include <stdio.h>
#include <boost/shared_ptr.hpp>
#include "ConstHDF.h"
#include "Cookie.h"
#include "HDF.h"
#include "TraceObject.h"

class _cgi;

namespace ClearSilver
{

  class URL;                    // forward declaration

class CGI : TraceObject
{
public:
  //\{
                                // constructors ClearSilver
  CGI ();
  explicit CGI (const HDF&);
  CGI (const CGI&);
  ~CGI () throw();
  CGI& operator = (const CGI&);

  void swap (CGI&) throw();
  //\}

  //\{
  operator bool () const;
  //\}

  //\{
  ConstHDF hdf () const;
  HDF hdf ();
  std::string DocumentRoot () const;
  std::string ScriptFilename () const;
  std::string ScriptDirectory () const;
  std::string ScriptBasename () const;
  std::string ScriptBasename (const char * suffix) const;
 std::string ScriptBasename (const std::string& suffix) const;
  //\}

  //\{
  void display (const char* cs_file) const;
  void display (const std::string& cs_file) const;
  //\}

  //\{
  void redirect (const URL&);
  void redirect_path (const URL&);
  //\}

  //\{
  void set (const Cookie&);
  void clear (const Cookie&);
  Cookie::Authority cookie_authority (const char * host) const;
  Cookie::Authority cookie_authority (const std::string& host) const;
  //\}

  //\{
  std::FILE* upload () const;
  std::FILE* upload (const char *) const;
  std::FILE* upload (const std::string&) const;
  //\}

  static bool& debug ();

private:
  typedef boost::shared_ptr<_cgi> Ptr;

private:
  Ptr cgi_;
  HDF hdf_;
};

};                              // namespace ClearSilver

#endif

---