1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of Qt Creator.
7 **
8 ** Commercial License Usage
9 ** Licensees holding valid commercial Qt licenses may use this file in
10 ** accordance with the commercial license agreement provided with the
11 ** Software or, alternatively, in accordance with the terms contained in
12 ** a written agreement between you and The Qt Company. For licensing terms
13 ** and conditions see https://www.qt.io/terms-conditions. For further
14 ** information use the contact form at https://www.qt.io/contact-us.
15 **
16 ** GNU General Public License Usage
17 ** Alternatively, this file may be used under the terms of the GNU
18 ** General Public License version 3 as published by the Free Software
19 ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
20 ** included in the packaging of this file. Please review the following
21 ** information to ensure the GNU General Public License requirements will
22 ** be met: https://www.gnu.org/licenses/gpl-3.0.html.
23 **
24 ****************************************************************************/
25 
26 #pragma once
27 
28 #include "cpptools_global.h"
29 #include "senddocumenttracker.h"
30 
31 #include <QString>
32 
33 namespace CppTools {
34 class BaseEditorDocumentProcessor;
35 
36 class CPPTOOLS_EXPORT CppEditorDocumentHandle
37 {
38 public:
39     virtual ~CppEditorDocumentHandle();
40 
41     enum RefreshReason {
42         None,
43         ProjectUpdate,
44         Other,
45     };
46     RefreshReason refreshReason() const;
47     void setRefreshReason(const RefreshReason &refreshReason);
48 
49     // For the Working Copy
50     virtual QString filePath() const = 0;
51     virtual QByteArray contents() const = 0;
52     virtual unsigned revision() const = 0;
53 
54     // For updating if new project info is set
55     virtual BaseEditorDocumentProcessor *processor() const = 0;
56 
57     virtual void resetProcessor() = 0;
58 
59     SendDocumentTracker &sendTracker();
60 
61 private:
62     SendDocumentTracker m_sendTracker;
63     RefreshReason m_refreshReason = None;
64 };
65 
66 } // namespace CppTools
67