xref: /llvm-project/clang/lib/Frontend/TestModuleFileExtension.h (revision 08ccea019fda514ae36454f8d607b6c3cb08698e)
1 //===-- TestModuleFileExtension.h - Module Extension Tester -----*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 #ifndef LLVM_CLANG_FRONTEND_TESTMODULEFILEEXTENSION_H
9 #define LLVM_CLANG_FRONTEND_TESTMODULEFILEEXTENSION_H
10 
11 #include "clang/Serialization/ModuleFileExtension.h"
12 #include "clang/Basic/LLVM.h"
13 #include "llvm/ADT/StringRef.h"
14 #include "llvm/Bitstream/BitstreamReader.h"
15 #include <string>
16 
17 namespace clang {
18 
19 /// A module file extension used for testing purposes.
20 class TestModuleFileExtension : public ModuleFileExtension {
21   std::string BlockName;
22   unsigned MajorVersion;
23   unsigned MinorVersion;
24   bool Hashed;
25   std::string UserInfo;
26 
27   class Writer : public ModuleFileExtensionWriter {
28   public:
29     Writer(ModuleFileExtension *Ext) : ModuleFileExtensionWriter(Ext) { }
30     ~Writer() override;
31 
32     void writeExtensionContents(Sema &SemaRef,
33                                 llvm::BitstreamWriter &Stream) override;
34   };
35 
36   class Reader : public ModuleFileExtensionReader {
37     llvm::BitstreamCursor Stream;
38 
39   public:
40     ~Reader() override;
41 
42     Reader(ModuleFileExtension *Ext, const llvm::BitstreamCursor &InStream);
43   };
44 
45 public:
46   TestModuleFileExtension(StringRef BlockName,
47                           unsigned MajorVersion,
48                           unsigned MinorVersion,
49                           bool Hashed,
50                           StringRef UserInfo)
51     : ModuleFileExtension(ModuleFileExtensionKind::MFEK_Test),
52       BlockName(BlockName),
53       MajorVersion(MajorVersion), MinorVersion(MinorVersion),
54       Hashed(Hashed), UserInfo(UserInfo) { }
55   ~TestModuleFileExtension() override;
56 
57   ModuleFileExtensionMetadata getExtensionMetadata() const override;
58 
59   llvm::hash_code hashExtension(llvm::hash_code Code) const override;
60 
61   std::unique_ptr<ModuleFileExtensionWriter>
62   createExtensionWriter(ASTWriter &Writer) override;
63 
64   std::unique_ptr<ModuleFileExtensionReader>
65   createExtensionReader(const ModuleFileExtensionMetadata &Metadata,
66                         ASTReader &Reader, serialization::ModuleFile &Mod,
67                         const llvm::BitstreamCursor &Stream) override;
68 
69   static bool classof(const ModuleFileExtension *E) {
70     return E->getKind() == MFEK_Test;
71   }
72 
73   std::string str() const;
74 };
75 
76 } // end namespace clang
77 
78 #endif // LLVM_CLANG_FRONTEND_TESTMODULEFILEEXTENSION_H
79