001/* 002 * SonarQube 003 * Copyright (C) 2009-2016 SonarSource SA 004 * mailto:contact 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 org.sonar.api.component.Perspective; 023import org.sonar.api.component.ResourcePerspectives; 024 025import java.util.List; 026 027/** 028 * Use this perspective to save symbol references on files. 029 * See {@link ResourcePerspectives}. 030 * @since 3.6 031 */ 032public interface Symbolizable extends Perspective { 033 034 interface SymbolTableBuilder { 035 036 /** 037 * Creates a new Symbol. 038 * The offsets are global in the file. 039 */ 040 Symbol newSymbol(int fromOffset, int toOffset); 041 042 /** 043 * Creates a new reference for a symbol. 044 * The length of the reference is assumed to be the same as the symbol's length. 045 */ 046 void newReference(Symbol symbol, int fromOffset); 047 048 /** 049 * Creates a new reference for a symbol. 050 * The offsets are global in the file. 051 */ 052 void newReference(Symbol symbol, int fromOffset, int toOffset); 053 054 /** 055 * Creates a {@link SymbolTable} containing all symbols and references previously created in this file. 056 */ 057 SymbolTable build(); 058 059 } 060 061 interface SymbolTable { 062 063 List<Symbol> symbols(); 064 065 /** 066 * @deprecated since 5.2 not used 067 */ 068 @Deprecated 069 List<Integer> references(Symbol symbol); 070 } 071 072 SymbolTableBuilder newSymbolTableBuilder(); 073 074 void setSymbolTable(SymbolTable symbolTable); 075}