xref: /freebsd/contrib/kyua/engine/scanner_fwd.hpp (revision cab6a39d7b343596a5823e65c0f7b426551ec22d)
1 // Copyright 2015 The Kyua Authors.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 //   notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 //   notice, this list of conditions and the following disclaimer in the
12 //   documentation and/or other materials provided with the distribution.
13 // * Neither the name of Google Inc. nor the names of its contributors
14 //   may be used to endorse or promote products derived from this software
15 //   without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 /// \file engine/scanner_fwd.hpp
30 /// Forward declarations for engine/scanner.hpp
31 
32 #if !defined(ENGINE_SCANNER_FWD_HPP)
33 #define ENGINE_SCANNER_FWD_HPP
34 
35 #include <string>
36 #include <utility>
37 
38 #include "model/test_program_fwd.hpp"
39 
40 namespace engine {
41 
42 
43 /// Result type yielded by the scanner: a (test program, test case name) pair.
44 ///
45 /// We must use model::test_program_ptr here instead of model::test_program
46 /// because we must keep the polimorphic properties of the test program.  In
47 /// particular, if the test program comes from the Kyuafile and is of the type
48 /// model::lazy_test_program, we must keep access to the loaded list of test
49 /// cases (which, for obscure reasons, is kept in the subclass).
50 /// TODO(jmmv): This is ugly, very ugly.  There has to be a better way.
51 typedef std::pair< model::test_program_ptr, std::string > scan_result;
52 
53 
54 class scanner;
55 
56 
57 }  // namespace engine
58 
59 #endif  // !defined(ENGINE_SCANNER_FWD_HPP)
60