Parser.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2013 Jonathan Anderson
 * All rights reserved.
 *
 * This software was developed by SRI International and the University of
 * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
 * ("CTSRD"), as part of the DARPA CRASH research programme.
 *
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
 */

#ifndef PARSER_H
#define PARSER_H

#include <tesla.pb.h>

#include <llvm/ADT/APInt.h>
#include <llvm/ADT/OwningPtr.h>

#include <string>
#include <vector>

namespace clang {
  class ASTContext;
  class BinaryOperator;
  class CallExpr;
  class CompoundStmt;
  class Decl;
  class DeclRefExpr;
  class Expr;
  class FunctionDecl;
  class MemberExpr;
  class SourceLocation;
  class SourceRange;
  class Stmt;
  class UnaryOperator;
  class ValueDecl;
}

namespace llvm {
  class APSInt;
}


namespace tesla {

class Parser {
public:
  typedef std::vector<const clang::ValueDecl*> RefVector;

  static Parser* AssertionParser(clang::CallExpr*, clang::ASTContext&);

  static Parser* AutomatonParser(clang::FunctionDecl*, clang::ASTContext&);

  static Parser* MappingParser(clang::FunctionDecl*, clang::ASTContext&);

  bool Parse(llvm::OwningPtr<AutomatonDescription>& Descrip,
             llvm::OwningPtr<Usage>& Usage);


private:
  class Flags {
  public:
    FunctionEvent::CallContext FnInstrContext;

    BooleanExpr::Operation OrOperator;

    bool StrictMode;
  };

  Parser(clang::ASTContext& Ctx, Identifier ID = Identifier(),
         AutomatonDescription::Context C = AutomatonDescription::Global,
         clang::Expr* Begin = NULL, clang::Expr* End = NULL,
         clang::Stmt *Root = NULL, Flags InitialFlags = Flags())
    : Ctx(Ctx), ID(ID), TeslaContext(C), Beginning(Begin), End(End),
      Root(Root), RootFlags(InitialFlags)
  {
  }

  bool Parse(Location*, clang::Expr*, clang::Expr*, clang::Expr*);
  bool Parse(AutomatonDescription::Context*, clang::Expr*);

  bool Parse(Expression*, const clang::CompoundStmt*, Flags);
  bool Parse(Expression*, const clang::Expr*, Flags);
  bool Parse(Expression*, const clang::BinaryOperator*, Flags);
  bool Parse(Expression*, const clang::CallExpr*, Flags);
  bool Parse(Expression*, const clang::DeclRefExpr*, Flags);
  bool Parse(Expression*, const clang::UnaryOperator*, Flags);

  bool Parse(FunctionRef*, const clang::FunctionDecl*, Flags);
  bool Parse(Argument*, const clang::Expr*, Flags);
  bool Parse(Argument*, const clang::ValueDecl*, bool AllowAny, Flags);

  bool ParseStructField(StructField*, const clang::MemberExpr*, Flags);
  bool ParseSubAutomaton(Expression*, const clang::CallExpr*, Flags);
  bool ParsePredicate(Expression*, const clang::CallExpr*, Flags);

  // TESLA predicates:
  typedef bool (Parser::*CallParser)(Expression*, const clang::CallExpr*,
                                     Flags);

  bool ParseFunctionCall(Expression*, const clang::CallExpr*, Flags);
  bool ParseFunctionReturn(Expression*, const clang::CallExpr*, Flags);
  bool ParseCallee(Expression*, const clang::CallExpr*, Flags);
  bool ParseCaller(Expression*, const clang::CallExpr*, Flags);
  bool ParseStrictMode(Expression*, const clang::CallExpr*, Flags);
  bool ParseConditional(Expression*, const clang::CallExpr*, Flags);
  bool ParseOptional(Expression*, const clang::CallExpr*, Flags);
  bool ParseSequence(Expression*, const clang::CallExpr*, Flags);

  bool ParseFunctionPredicate(FunctionEvent*, const clang::CallExpr*,
                              bool ParseRetVal, Flags);

  bool ParseFunctionCall(Expression*, const clang::BinaryOperator*, Flags);

  bool ParseFieldAssign(Expression*, const clang::BinaryOperator*, Flags);


  bool CheckIgnore(const clang::Expr*);

  bool CheckAssignmentKind(const clang::ValueDecl*, const clang::Expr*);

  std::string ParseStringLiteral(const clang::Expr*);

  llvm::APInt ParseIntegerLiteral(const clang::Expr*);


  size_t ReferenceIndex(const clang::ValueDecl*);


  void ReportError(llvm::StringRef Message, const clang::Decl*);
  void ReportError(llvm::StringRef Message, const clang::Stmt*);
  void ReportError(llvm::StringRef Message, const clang::SourceLocation&,
                   const clang::SourceRange&);



  clang::ASTContext& Ctx;

  const Identifier ID;
  const AutomatonDescription::Context TeslaContext;
  const clang::Expr *Beginning;     
  const clang::Expr *End;           
  const clang::Stmt *Root;          
  const Flags RootFlags;

  std::map<const clang::ValueDecl*, const clang::Expr*> FieldAssignments;
  RefVector References;
};

}

#endif  // PARSERS_H