plugins/teamwork/indocumentreference.cpp

   1 /***************************************************************************
   2 Copyright 2006 David Nolden <david.nolden.kdevelop@art-master.de>
   3 ***************************************************************************/
   4
   5 /***************************************************************************
   6  *                                                                         *
   7  *   This program is free software; you can redistribute it and/or modify  *
   8  *   it under the terms of the GNU General Public License as published by  *
   9  *   the Free Software Foundation; either version 2 of the License, or     *
  10  *   (at your option) any later version.                                   *
  11  *                                                                         *
  12  ***************************************************************************/
  13 #include "indocumentreference.h"
  14 #include "utils.h"
  15
  16 /* Exclude this file from doublequote_chars check as krazy doesn't understand
  17 std::string*/
  18 //krazy:excludeall=doublequote_chars
  19
  20 QString InDocumentReference::createReference( const QString& file, int startLine, int startCol, int endLine, int endCol ) {
  21         QString ret = file;
  22         if( startLine != -1 ) ret.append( QString( ":%1" ).arg( startLine ) );
  23         if( startCol != -1 ) ret.append( QString( ":%1" ).arg( startCol ) );
  24         if( endLine != -1 ) ret.append( QString( ":%1" ).arg( endLine ) );
  25         if( endCol != -1 ) ret.append( QString( ":%1" ).arg( endCol ) );
  26         return ret;
  27 }
  28
  29 void InDocumentReference::parseReference( const QString& ref, QString& file, int& startLine, int& startCol, int& endLine, int& endCol ) {
  30         file = "";
  31         startLine = endLine = startCol = endCol = -1;
  32         if ( ref.indexOf( ':' ) != -1 ) {
  33                 file = ref.left( ref.indexOf( ':' ) );
  34
  35                 QString tail = ref.mid( file.length()+1 );
  36
  37                 int refs[4] = {-1, -1, -1, -1};
  38                 for( int a = 0; a < 4; a++ ) {
  39                         if( tail.isEmpty() ) break;
  40                         int nextPos = tail.indexOf( ':' );
  41                         if( nextPos == -1 ) nextPos = tail.length();
  42                         refs[a] = tail.left( nextPos ).toInt();
  43                         tail = tail.mid( nextPos+1 );
  44                         if( tail.isEmpty() ) break;
  45                 }
  46
  47                 startLine = refs[0];
  48                 startCol = refs[1];
  49                 endLine = refs[2];
  50                 endCol = refs[3];
  51         }
  52 }
  53
  54 ///This creates a reference that refers to a position, but not intelligently.
  55 InDocumentReference::InDocumentReference( bool start, const QString& ref ) : m_line( -1 ), m_col( -1 ) {
  56         int d1, d2;
  57         QString doc;
  58         if( start )
  59                 parseReference( ref, doc, m_line, m_col, d1, d2 );
  60         else
  61                 parseReference( ref, doc, d1, d2, m_line, m_col );
  62         m_document = ~doc;
  63 }
  64
  65 InDocumentReference::InDocumentReference( const QString& document, int line, int col, const QString& text ) {
  66         m_line = line;
  67         m_document = ~document;
  68         m_col = col;
  69         if ( !text.isEmpty() )
  70                 useText( text );
  71 }
  72
  73 void InDocumentReference::useText( const QString& text ) {
  74         if ( m_line == -1 )
  75                 return ;
  76         int index = lineColToIndex( text, m_line, m_col == -1 ? 0 : m_col );
  77         if ( index != -1 ) {
  78                 SumSearch<10> search( ~text );
  79                 m_position = search.getReference( index );
  80         }
  81 }
  82
  83 QString InDocumentReference::document() const {
  84         return ~m_document;
  85 }
  86
  87 struct InDocumentReference::TextSearchInstance::Private : public Shared {
  88         SumSearch<10> search;
  89         QString text;
  90
  91         Private( const QString& txt ) : search( ~txt ), text( txt ) {
  92
  93         }
  94 };
  95
  96
  97 InDocumentReference::TextSearchInstance::TextSearchInstance( const TextSearchInstance& rhs ) {
  98         *this = rhs;
  99 }
 100
 101 InDocumentReference::TextSearchInstance::TextSearchInstance( const QString& txt ) {
 102         m_data = new Private( txt );
 103 }
 104
 105 InDocumentReference::TextSearchInstance::TextSearchInstance() {
 106 }
 107
 108 QString InDocumentReference::TextSearchInstance::text() const {
 109         if( !m_data ) return "";
 110         else
 111                 return m_data->text;
 112 }
 113
 114 InDocumentReference::TextSearchInstance::~TextSearchInstance() {
 115 }
 116
 117 InDocumentReference::TextSearchInstance& InDocumentReference::TextSearchInstance::operator = ( const TextSearchInstance& rhs ) {
 118         m_data = rhs.m_data;
 119         return *this;
 120 }
 121
 122 InDocumentReference::TextSearchInstance::operator bool() const {
 123         return (bool)m_data;
 124 }
 125
 126 ///Finds the reference-position dynamically within the given text. If the search fails, puts -1 -1.
 127 void InDocumentReference::findInText( const TextSearchInstance& text, int& line, int& col ) const {
 128         if ( !isValid() || !text ) {
 129                 line = -1;
 130                 col = -1;
 131                 return ;
 132         }
 133         int pos = text.m_data->search.findReference( m_position );
 134
 135         if ( pos == -1 ) {
 136                 line = -1;
 137                 col = -1;
 138                 return ;
 139     /*
 140     ///Fall bock to returning the fixed line- and column-numbers
 141                 line = m_line;
 142                 if( m_col != -1 )
 143                 col = m_col;
 144                 else
 145                 col = 0; */
 146         } else {
 147                 indexToLineCol( pos, text.m_data->text, line, col );
 148         }
 149 }
 150
 151 bool InDocumentReference::isValid() const {
 152         return ( m_line != -1 ) && !m_document.empty();
 153 }
 154
 155 bool InDocumentReference::isDynamic() const {
 156         return m_position.isValid();
 157 }
 158
 159 InDocumentReference::operator bool() const {
 160         return isValid();
 161 }
 162
 163 ///findInText(..) should be preferred, because it can find the correct position even if the text changed.
 164 int InDocumentReference::line() const {
 165         return m_line;
 166 }
 167
 168 QString InDocumentReference::asText() const {
 169         QString ret = QString( "%1" ).arg( m_line );
 170         if ( m_col != 0 && m_col != -1 )
 171                 ret += QString( ":%1" ).arg( m_col );
 172         if ( m_position.isValid() )
 173                 ret = "~" + ret;
 174         return ret;
 175 }
 176
 177 int InDocumentReference::col() const {
 178         if ( m_col != -1 )
 179                 return m_col;
 180         else
 181                 return 0;
 182 }
 183
 184 DocumentContextLines::DocumentContextLines() : m_lineOffset( 0 ) {}
 185
 186 DocumentContextLines::DocumentContextLines( const InDocumentReference& beginRef, const InDocumentReference& endRef, const QString& text, int /*contextSize*/ ) : m_lineOffset( 0 ) {
 187         int startLine = beginRef.line();
 188         int endLine = endRef.line();
 189         if ( startLine == -1 )
 190                 return ;
 191         m_lineOffset = startLine - 5;
 192         if ( endLine == -1 )
 193                 endLine = startLine;
 194         int end = endLine + 5;
 195         if ( m_lineOffset < 0 )
 196                 m_lineOffset = 0;
 197         if ( end < m_lineOffset )
 198                 end = m_lineOffset + 1;
 199
 200         int i = lineColToIndex( text, m_lineOffset, 0 );
 201         if ( i == -1 ) {
 202                 m_lineOffset = 0;
 203                 return ;
 204         }
 205         int endI = lineColToIndex( text, end, 0 );
 206         if ( endI == -1 )
 207                 endI = text.size();
 208
 209         m_lines = ~text.mid( i, endI - i );
 210 }
 211
 212 DocumentContextLines::operator bool() const {
 213         return !m_lines.empty();
 214 }
 215
 216 QString DocumentContextLines::text() const {
 217         return ~m_lines;
 218 }
 219
 220 int DocumentContextLines::lineOffset() const {
 221         return m_lineOffset;
 222 }
 223