enhance.cxx

Go to the documentation of this file.

// @(#)root/editline:$Id: enhance.cxx 30349 2009-09-22 10:35:20Z axel $
// Author: Mary-Louise Gill, 2009

/*************************************************************************
 * Copyright (C) 1995-2009, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/

#include "el.h"
#include <stack>
#include <set>
#include <string>

#include "TROOT.h"
#include "TInterpreter.h"

using namespace std;

void setKeywordColors(const char* colorTab, const char* colorBracket, const char* colorBadBracket);
int selectColor(const char* str);
void highlightKeywords(EditLine_t* el);
int matchParentheses(EditLine_t* el);
void colorWord(EditLine_t* el, int first, int num, int color);
void colorBrackets(EditLine_t* el, int open, int close, int color);
char** rl_complete2ROOT(const char*, int, int);

// int values for colour highlighting
int color_class = 4;           // NCurses COLOR_BLUE
int color_type = 4;            // NCurses COLOR_BLUE
int color_bracket = 2;         // NCurses COLOR_GREEN
int color_badbracket = 1;      // NCurses COLOR_RED

/**
 *   Sets the colours to use for highlighting keywords (types and classnames),
 *   matching bracket pairs, mismatched brackets and tab completion.
 *   Overrides the default colour settings:
 *   class and type: 4 (blue)
 *   bracket pair:   2 (green)
 *   bad bracket:   1 (red)
 */
void
setKeywordColors(int colorType, int colorBracket, int colorBadBracket) {
   color_class = colorType;
   color_type = colorType;
   color_bracket = colorBracket;
   color_badbracket = colorBadBracket;
} // setKeywordColors


/*
 *      Use gRoot to establish keywords known to root.
 *
 */
void
highlightKeywords(EditLine_t* el) {
   typedef std::set<int> HashSet_t;
   static HashSet_t sHashedKnownTypes;

   TString sBuffer(el->fLine.fBuffer, el->fLine.fLastChar - el->fLine.fBuffer);

   TString keyword;
   Ssiz_t posNextTok = 0;
   Ssiz_t posPrevTok = 0;

   // regular expression inverse of match expression to find end of match
   while (sBuffer.Tokenize(keyword, posNextTok, "[^a-zA-Z0-9_]")) {
      Ssiz_t toklen = posNextTok - posPrevTok;

      if (posNextTok == -1) {
         toklen = sBuffer.Length() - posPrevTok;
      }
      TString tok = sBuffer(posPrevTok, toklen);
      Ssiz_t pos = posPrevTok + tok.Index(keyword);
      int color = -1;

      if (gROOT->GetListOfTypes()->FindObject(keyword)) {
         color = color_type;
      } else if (gInterpreter->CheckClassInfo(keyword, kFALSE)) {
         color = color_class;
      }
      colorWord(el, pos, keyword.Length(), color);
      posPrevTok = posNextTok;
   }
} // highlightKeywords


/** if buffer has content, check each char to see if it is an opening bracket,
    if so, check for its closing one and return the indices to both
 * alt:
 * check each char for a match against each type of open and close bracket
 * if open found, push index onto a seperate stack for each type of bracket
 * if close found, pop previous value off relevant stack
 * and pass both pointers to highlight()
 */
int
matchParentheses(EditLine_t* el) {
   static const int amtBrackets = 3;
   int bracketPos = -1;
   int foundParenIdx = -1;
   char bTypes[amtBrackets][2];

   bTypes[0][0] = '(';
   bTypes[0][1] = ')';
   bTypes[1][0] = '{';
   bTypes[1][1] = '}';
   bTypes[2][0] = '[';
   bTypes[2][1] = ']';
   //static char bTypes[] = "(){}[]"; with strchr(bTypes, sBuffer[bracketPos])

   // CURRENT STUFF
   // create a string of the buffer contents
   std::string sBuffer = "";

   for (char* c = el->fLine.fBuffer; c < el->fLine.fLastChar; c++) {
      sBuffer += *c;
   }

   // check whole buffer for any highlighted brackets and remove colour info
   for (int i = 0; i < (el->fLine.fLastChar - el->fLine.fBuffer); i++) {
      if (el->fLine.fBufColor[i].fForeColor == color_bracket || el->fLine.fBufColor[i].fForeColor == color_badbracket) {
         el->fLine.fBufColor[i] = -1;                      // reset to default colours
         term__repaint(el, i);
      }
   }

   // char* stack for pointers to locations of brackets
   stack<int> locBrackets;

   if (!sBuffer.empty()) {
      int cursorPos = el->fLine.fCursor - el->fLine.fBuffer;
      bracketPos = cursorPos;

      // check against each bracket type
      int bIndex = 0;

      for (bIndex = 0; bIndex < amtBrackets; bIndex++) {
         // if current char is equal to opening bracket, push onto stack
         if (sBuffer[bracketPos] == bTypes[bIndex][0]) {
            locBrackets.push(bracketPos);
            foundParenIdx = 0;
            break;
         } else if (sBuffer[bracketPos] == bTypes[bIndex][1]) {
            locBrackets.push(bracketPos);
            foundParenIdx = 1;
            break;
         }
      }

      // current cursor char is not an open bracket, and there is a previous char to check
      if (foundParenIdx == -1 && bracketPos > 0) {
         //check previously typed char for being a closing bracket
         bracketPos--;
         // check against each bracket type
         bIndex = 0;

         for (bIndex = 0; bIndex < amtBrackets; bIndex++) {
            // if current char is equal to closing bracket, push onto stack
            if (sBuffer[bracketPos] == bTypes[bIndex][1]) {
               locBrackets.push(bracketPos);
               foundParenIdx = 1;
               break;
            }
         }
      }

      // no bracket found on either current or previous char, return.
      if (foundParenIdx == -1) {
         return foundParenIdx;
      }

      // iterate through remaining letters until find a matching closing bracket
      // if another open bracket of the same type is found, push onto stack
      // and pop on next closing bracket match
      int step = 1;

      if (foundParenIdx == 1) {
         step = -1;
      }

      for (int i = bracketPos + step; i >= 0 && i < (int)sBuffer.size(); i += step) {
         //if current char is equal to another opening bracket, push onto stack
         if (sBuffer[i] == bTypes[bIndex][foundParenIdx]) {
            // push index of bracket
            locBrackets.push(i);
         }
         //if current char is equal to closing bracket
         else if (sBuffer[i] == bTypes[bIndex][1 - foundParenIdx]) {
            // pop previous opening bracket off stack
            locBrackets.pop();

            // if previous opening was the last entry, then highlight match
            if (locBrackets.empty()) {
               colorBrackets(el, bracketPos, i, color_bracket);
               break;
            }
         }
      }

      if (!locBrackets.empty()) {
         colorBrackets(el, bracketPos, bracketPos, color_badbracket);
      }
   }

   return foundParenIdx;
} // matchParentheses


/**
 *      Highlight a word within the buffer.
 *      Requires the start and end index of the word, and the color pair index (class or type).
 *      Writes colour info for each char in range to el->fLine.bufcol.
 *      Background colour is set to the same as the current terminal background colour.
 *      Foreground (text) colour is set according to the type of word being highlighted (e.g. class or type).
 */
void
colorWord(EditLine_t* el, int first, int num, int textColor) {
   int bgColor = -1;            // default background
   bool anyChange = false;

   // add colour information to el.
   for (int index = first; index < first + num; ++index) {
      bool changed = el->fLine.fBufColor[index].fForeColor != textColor;
      anyChange |= changed;
      el->fLine.fBufColor[index].fForeColor = textColor;
      el->fLine.fBufColor[index].fBackColor = bgColor;

      if (changed) {
         term__repaint(el, index);
      }
   }

   if (anyChange) {
      term__setcolor(-1);
   }
} // colorWord


/*
 *      Set the colour information in the SEditLine_t buffer,
 *      Then call repaint to repaint the chars with the new colour information
 */
void
colorBrackets(EditLine_t* el, int open, int close, int textColor) {
   int bgColor = -1;            // default background

   el->fLine.fBufColor[open].fForeColor = textColor;
   el->fLine.fBufColor[open].fBackColor = bgColor;
   term__repaint(el, open);

   el->fLine.fBufColor[close].fForeColor = textColor;
   el->fLine.fBufColor[close].fBackColor = bgColor;
   term__repaint(el, close);

   term__setcolor(-1);
}

---