src/libbash.h


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

/*
   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
/// \author Mu Qiao
/// \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 "core/interpreter_exception.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
  void LIBBASH_API interpret(const std::string& path,
                             std::unordered_map<std::string, std::vector<std::string>>& variables,
                             std::vector<std::string>& functions);
}

#endif