Merge pull request #2626 from zachjs/param-no-default

[yosys.git] / kernel / register.h

diff --git a/kernel/register.h b/kernel/register.h
index 71ab6ea6ea6919e78f484b1003df4a5d5ba4807a..5cd8490824be7c749238dd707611c66cc26f3dbd 100644 (file)
--- a/kernel/register.h
+++ b/kernel/register.h
@@ -1,12 +1,12 @@
-/*
+/* -*- c++ -*-
  *  yosys -- Yosys Open SYnthesis Suite
  *
  *  Copyright (C) 2012  Clifford Wolf <clifford@clifford.at>
- *  
+ *
  *  Permission to use, copy, modify, and/or distribute this software for any
  *  purpose with or without fee is hereby granted, provided that the above
  *  copyright notice and this permission notice appear in all copies.
- *  
+ *
  *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  *  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  *  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
@@ -31,10 +31,16 @@ struct Pass
        virtual ~Pass();
 
        virtual void help();
+       virtual void clear_flags();
        virtual void execute(std::vector<std::string> args, RTLIL::Design *design) = 0;
 
        int call_counter;
        int64_t runtime_ns;
+       bool experimental_flag = false;
+
+       void experimental() {
+               experimental_flag = true;
+       }
 
        struct pre_post_exec_state_t {
                Pass *parent_pass;
@@ -61,6 +67,26 @@ struct Pass
        virtual void run_register();
        static void init_register();
        static void done_register();
+
+       virtual void on_register();
+       virtual void on_shutdown();
+};
+
+struct ScriptPass : Pass
+{
+       bool block_active, help_mode;
+       RTLIL::Design *active_design;
+       std::string active_run_from, active_run_to;
+
+       ScriptPass(std::string name, std::string short_help = "** document me **") : Pass(name, short_help) { }
+
+       virtual void script() = 0;
+
+       bool check_label(std::string label, std::string info = std::string());
+       void run(std::string command, std::string info = std::string());
+       void run_nocheck(std::string command, std::string info = std::string());
+       void run_script(RTLIL::Design *design, std::string run_from = std::string(), std::string run_to = std::string());
+       void help_script();
 };
 
 struct Frontend : Pass
@@ -71,13 +97,13 @@ struct Frontend : Pass
 
        std::string frontend_name;
        Frontend(std::string name, std::string short_help = "** document me **");
-       virtual void run_register();
-       virtual ~Frontend();
-       virtual void execute(std::vector<std::string> args, RTLIL::Design *design) YS_OVERRIDE YS_FINAL;
+       void run_register() override;
+       ~Frontend() override;
+       void execute(std::vector<std::string> args, RTLIL::Design *design) override final;
        virtual void execute(std::istream *&f, std::string filename, std::vector<std::string> args, RTLIL::Design *design) = 0;
 
        static std::vector<std::string> next_args;
-       void extra_args(std::istream *&f, std::string &filename, std::vector<std::string> args, size_t argidx);
+       void extra_args(std::istream *&f, std::string &filename, std::vector<std::string> args, size_t argidx, bool bin_input = false);
 
        static void frontend_call(RTLIL::Design *design, std::istream *f, std::string filename, std::string command);
        static void frontend_call(RTLIL::Design *design, std::istream *f, std::string filename, std::vector<std::string> args);
@@ -87,19 +113,19 @@ struct Backend : Pass
 {
        std::string backend_name;
        Backend(std::string name, std::string short_help = "** document me **");
-       virtual void run_register();
-       virtual ~Backend();
-       virtual void execute(std::vector<std::string> args, RTLIL::Design *design) YS_OVERRIDE YS_FINAL;
+       void run_register() override;
+       ~Backend() override;
+       void execute(std::vector<std::string> args, RTLIL::Design *design) override final;
        virtual void execute(std::ostream *&f, std::string filename,  std::vector<std::string> args, RTLIL::Design *design) = 0;
 
-       void extra_args(std::ostream *&f, std::string &filename, std::vector<std::string> args, size_t argidx);
+       void extra_args(std::ostream *&f, std::string &filename, std::vector<std::string> args, size_t argidx, bool bin_output = false);
 
        static void backend_call(RTLIL::Design *design, std::ostream *f, std::string filename, std::string command);
        static void backend_call(RTLIL::Design *design, std::ostream *f, std::string filename, std::vector<std::string> args);
 };
 
 // implemented in passes/cmds/select.cc
-extern void handle_extra_select_args(Pass *pass, std::vector<std::string> args, size_t argidx, size_t args_size, RTLIL::Design *design);
+extern void handle_extra_select_args(Pass *pass, const std::vector<std::string> &args, size_t argidx, size_t args_size, RTLIL::Design *design);
 extern RTLIL::Selection eval_select_args(const vector<string> &args, RTLIL::Design *design);
 extern void eval_select_op(vector<RTLIL::Selection> &work, const string &op, RTLIL::Design *design);