blob: 26efb9e36b37ab5686e113564fe6558a43783901 (
plain) (
blame)
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
/*******************************************************************************
* Copyright (c) 2007, 2009 Wind River Systems, Inc. and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Markus Schorn - initial API and implementation
*******************************************************************************/
package org.eclipse.cdt.internal.core.pdom;
import org.eclipse.cdt.core.index.IIndexFileLocation;
import org.eclipse.cdt.core.model.AbstractLanguage;
import org.eclipse.cdt.core.parser.FileContent;
import org.eclipse.cdt.core.parser.IScannerInfo;
/**
* Abstract class to obtain information about the input to the indexer. For the
* project based indexers the input are translation units, for the stand-alone
* indexer they are file-paths represented as strings.
* @since 5.0
*/
public abstract class IndexerInputAdapter extends ASTFilePathResolver {
/**
* Returns an object representing an input file for the given index location,
* or <code>null</code>, if it does not exist.
*/
public abstract Object getInputFile(IIndexFileLocation location);
/**
* Return the last modification date for the file denoted by the index location.
*/
public abstract long getLastModified(IIndexFileLocation location);
/**
* Create an index location for the given input file.
*/
public abstract IIndexFileLocation resolveFile(Object tu);
/**
* Tests whether the input file is a source unit.
*/
public abstract boolean isSourceUnit(Object tu);
/**
* Tests whether the input file is part of the build.
*/
public abstract boolean isFileBuildConfigured(Object tu);
/**
* Returns whether the given translation unit is not indexed unless it gets included.
* This applies to files that are outside of a source root.
*/
public abstract boolean isIndexedOnlyIfIncluded(Object tu);
/**
* Checks whether the given file should be indexed unconditionally.
* @param ifl The Location of the file.
* @return {@code true} if the file should be indexed unconditionally.
*/
public abstract boolean isIndexedUnconditionally(IIndexFileLocation ifl);
/**
* Tests whether the file in the index is allowed to be part of an SDK. If not
* it will be indexed.
*/
public abstract boolean canBePartOfSDK(IIndexFileLocation ifl);
/**
* Obtains the languages the input file should be parsed with.
*/
public abstract AbstractLanguage[] getLanguages(Object tu, boolean bothForHeaders);
/**
* Obtains the scanner configuration for the input file.
*/
public abstract IScannerInfo getBuildConfiguration(int linkageID, Object tu);
/**
* Returns a code reader for the given input file.
*/
public abstract FileContent getCodeReader(Object tu);
/**
* Returns the encoding for the file.
*/
public abstract String getEncoding(IIndexFileLocation ifl);
}
|
