1 files changed, 62 insertions, 0 deletions
diff --git a/include/libbash.h b/include/libbash.h
new file mode 100644
index 0000000..bc065f3
--- /dev/null
+++ b/include/libbash.h
@@ -0,0 +1,62 @@
+/*
+   Please use git log for copyright holder and year information
+
+   This file is part of libbash.
+
+   libbash is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 2 of the License, or
+   (at your option) any later version.
+
+   libbash is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with libbash.  If not, see <http://www.gnu.org/licenses/>.
+*/
+///
+/// \file libbash.h
+/// \brief public interface for libbash
+///
+
+#ifndef LIBBASH_LIBBASH_H_
+#define LIBBASH_LIBBASH_H_
+
+#include <memory>
+#include <string>
+#include <unordered_map>
+#include <vector>
+
+#include "common.h"
+#include "exceptions.h"
+
+namespace libbash
+{
+  ///
+  /// \brief interpret a script specifid by path, return a map filled with
+  ///        variables defined in the script
+  /// \param the path of target script
+  /// \param[in, out] we use the map to initialize bash environment and store the result
+  /// \param[out] store the names of the functions defined in the script
+  /// \return the return status of the script
+  int LIBBASH_API interpret(const std::string& target_path,
+                            std::unordered_map<std::string, std::vector<std::string>>& variables,
+                            std::vector<std::string>& functions);
+
+  ///
+  /// \brief interpret a script specifid by path, return a map filled with
+  ///        variables defined in the script
+  /// \param the path of target script
+  /// \param the path of a script that you want to source before interpreting
+  /// \param[in, out] we use the map to initialize bash environment and store the result. The environment will be initialized after preloading.
+  /// \param[out] store the names of the functions defined in the script
+  /// \return the return status of the script
+  int LIBBASH_API interpret(const std::string& target_path,
+                            const std::string& preload_path,
+                            std::unordered_map<std::string, std::vector<std::string>>& variables,
+                            std::vector<std::string>& functions);
+}
+
+#endif