001/* 002 * SonarQube 003 * Copyright (C) 2009-2017 SonarSource SA 004 * mailto:info AT sonarsource DOT com 005 * 006 * This program is free software; you can redistribute it and/or 007 * modify it under the terms of the GNU Lesser General Public 008 * License as published by the Free Software Foundation; either 009 * version 3 of the License, or (at your option) any later version. 010 * 011 * This program is distributed in the hope that it will be useful, 012 * but WITHOUT ANY WARRANTY; without even the implied warranty of 013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 * Lesser General Public License for more details. 015 * 016 * You should have received a copy of the GNU Lesser General Public License 017 * along with this program; if not, write to the Free Software Foundation, 018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 019 */ 020package org.sonar.api.source; 021 022import java.util.List; 023import org.sonar.api.batch.sensor.SensorContext; 024import org.sonar.api.component.Perspective; 025import org.sonar.api.component.ResourcePerspectives; 026 027/** 028 * Use this perspective to save symbol references on files. 029 * See {@link ResourcePerspectives}. 030 * @since 3.6 031 * @deprecated since 5.6 use {@link SensorContext#newSymbolTable()} 032 */ 033@Deprecated 034public interface Symbolizable extends Perspective { 035 036 interface SymbolTableBuilder { 037 038 /** 039 * Creates a new Symbol. 040 * The offsets are global in the file. 041 */ 042 Symbol newSymbol(int fromOffset, int toOffset); 043 044 /** 045 * @since 5.6 046 */ 047 Symbol newSymbol(int startLine, int startLineOffset, int endLine, int endLineOffset); 048 049 /** 050 * Creates a new reference for a symbol. 051 * The length of the reference is assumed to be the same as the symbol's length. 052 */ 053 void newReference(Symbol symbol, int fromOffset); 054 055 /** 056 * Creates a new reference for a symbol. 057 * The offsets are global in the file. 058 * 059 * @since 5.3 060 */ 061 void newReference(Symbol symbol, int fromOffset, int toOffset); 062 063 /** 064 * @since 5.6 065 */ 066 void newReference(Symbol symbol, int startLine, int startLineOffset, int endLine, int endLineOffset); 067 068 /** 069 * Creates a {@link SymbolTable} containing all symbols and references previously created in this file. 070 */ 071 SymbolTable build(); 072 073 } 074 075 interface SymbolTable { 076 077 List<Symbol> symbols(); 078 079 /** 080 * @deprecated since 5.2 not used 081 */ 082 @Deprecated 083 List<Integer> references(Symbol symbol); 084 } 085 086 SymbolTableBuilder newSymbolTableBuilder(); 087 088 void setSymbolTable(SymbolTable symbolTable); 089}