backend.hxx

Go to the documentation of this file.

#ifndef BACKEND_HXX
#define BACKEND_HXX

/**************************************************************************
 *
 * Copyright (C) 2008, Johns Hopkins University.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 *
 *   - Redistributions of source code must contain the above
 *     copyright notice, this list of conditions, and the following
 *     disclaimer.
 *
 *   - 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.
 *
 *   - Neither the names of the copyright holders nor the names of any
 *     of any contributors may be used to endorse or promote products
 *     derived from this software without specific prior written
 *     permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "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 COPYRIGHT
 * OWNER OR CONTRIBUTORS 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.
 *
 **************************************************************************/

#include <iostream>
#include "UocInfo.hxx"
#include "AST.hxx"

typedef bool (*BackEndFn) (std::ostream& out, std::ostream& err,
                           boost::shared_ptr<UocInfo> uoc);

typedef bool (*MidEndFn) (std::ostream& out, std::ostream& err);


/* @brief Emit output in XML pretty-printed form.
 *
 * This target has not been maintained in a long time, and should
 * probably be dropped.
 */
bool XMLpp(std::ostream& out, std::ostream& err, boost::shared_ptr<UocInfo> uoc);
/* Dump output in not-so-pretty XML form.
 *
 * This target has not been maintained in a long time, and should
 * probably be dropped.
 */
bool XMLdump(std::ostream& out, std::ostream& err, boost::shared_ptr<UocInfo> uoc);

/* @brief Emit output in XML pretty-printed form, including types */
bool XMLtypesPP(std::ostream& out, std::ostream& err, boost::shared_ptr<UocInfo> uoc);

/* @brief Emit a C header file containing the externalizable
 * declarations from every interface that was referenced by the input
 * units of compilation.
 */
bool EmitHeader(std::ostream& out, std::ostream& err,
                boost::shared_ptr<UocInfo> uoc);

/* @brief Emit a C source file that is the whole-program compilation
 * result for all input source files.
 *
 * The C file will include only those procedures that are reachable
 * from the entry points.
 */
bool EmitC(std::ostream& out, std::ostream& err, boost::shared_ptr<UocInfo> uoc);

/* @brief Emit a C source file as in EmitC, and compile the result to
 * an execuitable.
 */
bool EmitExe(std::ostream& out, std::ostream& err, boost::shared_ptr<UocInfo> uoc);

/* @brief Gather all of ths source units of compilation mentioned on
 * the command line into a quasi-archive file.
 *
 * This is a mid-end pass!
 */
bool EmitBitO(std::ostream& out, std::ostream& err);

struct BackEnd {
  std::string name;
  Pass needPass;
  OnePass oPass;
  BackEndFn fn;
  MidEndFn  midfn;
  BackEndFn plfn;

  unsigned long flags;

  static size_t nBackEnd;
  static BackEnd backends[];
};

#define BK_HDR_MODE 0x001u

#define BK_UOC_MODE 0x002u

#define BK_LINKING  0x004u

#endif /* BACKEND_HXX */

---