Changed LICENSE. Now referenced to web site and file on project root directory
[anna.git] / source / core / functions.cpp
index b007966..14ba7fc 100644 (file)
@@ -1,37 +1,9 @@
-// ANNA - Anna is Not Nothingness Anymore
-//
-// (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
-//
-// http://redmine.teslayout.com/projects/anna-suite
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions
-// are met:
-//
-//     * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-//     * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-//     *  Neither the name of the copyright holder nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-//
-// Authors: eduardo.ramos.testillano@gmail.com
-//          cisco.tierra@gmail.com
+// ANNA - Anna is Not Nothingness Anymore                                                         //
+//                                                                                                //
+// (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo                         //
+//                                                                                                //
+// See project site at http://redmine.teslayout.com/projects/anna-suite                           //
+// See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
 
 
 #include <stdarg.h>
@@ -260,14 +232,16 @@ throw() {
 }
 
 /**
- * Obtiene el valor original de una cadena obtenido con #asHexString (const DataBlock&).
- * \param hexString Cadena que contiene el búfer.
- * \param target Bloque de datos sobre el que decodificar la cadena.
- * \return El bloque de datos original correspondiente a la cadena recibida.
+ * Gets the original value obtained with #asHexString (const DataBlock&).
+ * \param hexString String which contains the buffer. The format is an hexadecimal octet sequence representation (i.e. 'af012fb3', with even number of digits).
+ * The input shall be preprocessed to comply with that format (e.g. colon or any other non-hex digit must be removed).
+ * \param target DataBlock for string decode.
+ * \return DataBlock corresponding to the provided string.
  */
 //static
 DataBlock& functions::fromHexString(const std::string& hexString, DataBlock& target)
 throw(RuntimeException) {
+
   if((hexString.length() % 2) != 0)
     throw RuntimeException("functions::fromHexString | Invalid string length", ANNA_FILE_LOCATION);
 
@@ -277,7 +251,7 @@ throw(RuntimeException) {
   int aux;
   int j = 0;
 
-  for(register int ii = 1, maxii = hexString.length(); ii < maxii; ii += 2) {
+  for(int ii = 1, maxii = hexString.length(); ii < maxii; ii += 2) {
     if(isxdigit(aux = src [ii - 1]) == 0)
       throw RuntimeException("Invalid HexString", ANNA_FILE_LOCATION);
 
@@ -450,7 +424,7 @@ throw() {
     7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7
   };
   int r = -1;     // r will be lg(v)
-  register unsigned int t, tt; // temporaries
+  unsigned int t, tt; // temporaries
 
   if(tt = v >> 16) {
     r = (t = tt >> 8) ? 24 + LogTable256[t] : 16 + LogTable256[tt];
@@ -488,7 +462,7 @@ std::string functions::justify(const std::string & title, TextJustifyMode::_v mo
   }
 
   if((mode == TextJustifyMode::Right) || (mode == TextJustifyMode::Center)) {
-    for(register int k = 0; k < (repeat + (adjust ? 1 : 0)); k++) result += filler;
+    for(int k = 0; k < (repeat + (adjust ? 1 : 0)); k++) result += filler;
 
     result += " ";
   }
@@ -498,7 +472,7 @@ std::string functions::justify(const std::string & title, TextJustifyMode::_v mo
   if((mode == TextJustifyMode::Left) || (mode == TextJustifyMode::Center)) {
     result += " ";
 
-    for(register int k = 0; k < repeat; k++) result += filler;
+    for(int k = 0; k < repeat; k++) result += filler;
   }
 
   return result;
@@ -517,13 +491,13 @@ std::string functions::highlight(const std::string & title, TextHighlightMode::_
   }
 
   if((mode == TextHighlightMode::Leftline) || (mode == TextHighlightMode::LeftAndRightline)) {
-    for(register int k = 0; k < (lr_repeat + (adjust ? 1 : 0)); k++) result += filler;
+    for(int k = 0; k < (lr_repeat + (adjust ? 1 : 0)); k++) result += filler;
 
     result += " ";
   }
 
   if((mode == TextHighlightMode::Overline) || (mode == TextHighlightMode::OverAndUnderline)) {
-    for(register int k = 0; k < ou_repeat; k++) result += filler;
+    for(int k = 0; k < ou_repeat; k++) result += filler;
 
     result += "\n";
   }
@@ -533,13 +507,13 @@ std::string functions::highlight(const std::string & title, TextHighlightMode::_
   if((mode == TextHighlightMode::Underline) || (mode == TextHighlightMode::OverAndUnderline)) {
     result += "\n";
 
-    for(register int k = 0; k < ou_repeat; k++) result += filler;
+    for(int k = 0; k < ou_repeat; k++) result += filler;
   }
 
   if((mode == TextHighlightMode::Rightline) || (mode == TextHighlightMode::LeftAndRightline)) {
     result += " ";
 
-    for(register int k = 0; k < lr_repeat; k++) result += filler;
+    for(int k = 0; k < lr_repeat; k++) result += filler;
   }
 
   if(appendCR) result += "\n";
@@ -553,7 +527,7 @@ std::string functions::tab(const std::string & text, int tabSpaces) throw() {
   size_t pos, from = 0;
   std::string tab, crTab = "\n";
 
-  for(register int k = 0; k < tabSpaces; k++) tab += " ";
+  for(int k = 0; k < tabSpaces; k++) tab += " ";
 
   crTab += tab;
   result = tab;
@@ -699,7 +673,7 @@ std::string functions::asAsciiString(const char * buffer, int size, bool & isFul
     return result;
   }
 
-  for(register int k = 0; k < size; k ++) {
+  for(int k = 0; k < size; k ++) {
     unsigned char c = (unsigned char) buffer [k];
     int printable = isprint(c);
     result += (printable ? (char) c : '.');
@@ -780,7 +754,7 @@ anna::DataBlock functions::rawIpPresentationAsRaw(const std::string & rawPresent
   char rByte[3]; // readable byte
   rByte[2] = 0;
 
-  for(register int k = 0; k < length; k += 2) {
+  for(int k = 0; k < length; k += 2) {
     rByte[0] =  rawPresentation[k];
     rByte[1] = rawPresentation[k + 1];
     sscanf(rByte, "%x", &byte);
@@ -802,7 +776,7 @@ std::string functions::rawIpAsRawIpPresentation(const anna::DataBlock & db) thro
   char rByte[3]; // readable byte
   rByte[2] = 0;
 
-  for(register int k = 0; k < length; k++) {
+  for(int k = 0; k < length; k++) {
     byte = (unsigned char)db[k];
     sprintf(rByte, "%.2X", byte);
     result += rByte;
@@ -864,7 +838,7 @@ bool functions::isIPv4(const std::string & ip, IPv4Type::_v ipv4Type) throw() {
     // La expresión regular no controla si hay mas de 3 puntos:
     int n_dot = 0;
 
-    for(register int k = 0; k < ip.length(); k++)
+    for(int k = 0; k < ip.length(); k++)
       if(ip[k] == '.') n_dot++;
 
     if(n_dot > 3)
@@ -911,7 +885,7 @@ bool functions::isIPv4(const std::string & ip, IPv4Type::_v ipv4Type) throw() {
 
 bool functions::isIPv6(const std::string & ip) throw() {
   // Chequeo de digitos permitidos:
-  for(register int k = 0; k < ip.length(); k++) {
+  for(int k = 0; k < ip.length(); k++) {
     bool digit = isdigit(ip[k]);
     bool hex = ((ip[k] == 'a') ||
                 (ip[k] == 'b') ||
@@ -965,7 +939,7 @@ std::string functions::IPv4To6(const std::string & ip) throw(anna::RuntimeExcept
   // Number of ocurrences for '.'
   int n_dot = 0;
 
-  for(register int k = 0; k < pureIPv4.length(); k++)
+  for(int k = 0; k < pureIPv4.length(); k++)
     if(pureIPv4[k] == '.') n_dot++;
 
   if(n_dot > 3)
@@ -1016,13 +990,13 @@ std::string functions::normalizeIP(const std::string & ip) throw(anna::RuntimeEx
     // Number of ocurrences for ':'
     int n_colon = 0;
 
-    for(register int k = 0; k < result.length(); k++)
+    for(int k = 0; k < result.length(); k++)
       if(result[k] == ':') n_colon++;
 
     // Generate equivalent to '::'
     std::string equiv_str;
 
-    for(register int k = 0; k < (8 - n_colon); k++)
+    for(int k = 0; k < (8 - n_colon); k++)
       equiv_str += ":0";
 
     equiv_str += ":";
@@ -1043,7 +1017,7 @@ std::string functions::normalizeIP(const std::string & ip) throw(anna::RuntimeEx
   // Protection: it must be seven colons:
   int n_colon = 0;
 
-  for(register int k = 0; k < result.length(); k++)
+  for(int k = 0; k < result.length(); k++)
     if(result[k] == ':') n_colon++;
 
   if(n_colon != 7)
@@ -1070,7 +1044,7 @@ std::string functions::normalizeIP(const std::string & ip) throw(anna::RuntimeEx
   result.erase(lastPos, 1);
 
   // Chequeo de digitos permitidos:
-  for(register int k = 0; k < result.length(); k++) {
+  for(int k = 0; k < result.length(); k++) {
     bool digit = isdigit(result[k]);
     bool hex = ((result[k] == 'a') ||
                 (result[k] == 'b') ||
@@ -1342,7 +1316,7 @@ throw() {
 const char* functions::codeInteger(char* result, const int n)
 throw() {
   int aux(htonl(n));
-  register char* w((char*) &aux);
+  char* w((char*) &aux);
   *result = *w;
   *(result + 1) = *(w + 1);
   *(result + 2) = *(w + 2);
@@ -1353,7 +1327,7 @@ throw() {
 const char* functions::codeShort(char* result, const short int n)
 throw() {
   short int aux(htons(n));
-  register char* w((char*) &aux);
+  char* w((char*) &aux);
   *result = *w;
   *(result + 1) = *(w + 1);
   return result;
@@ -1391,7 +1365,7 @@ throw() {
 int functions::decodeInteger(const char* data)
 throw() {
   int result;
-  register char* w((char*) &result);
+  char* w((char*) &result);
   *w  = *data;
   *(w + 1) = *(data + 1);
   *(w + 2) = *(data + 2);
@@ -1402,7 +1376,7 @@ throw() {
 short int functions::decodeShort(const char* data)
 throw() {
   short int result;
-  register char* w((char*) &result);
+  char* w((char*) &result);
   *w  = *data;
   *(w + 1) = *(data + 1);
   return ntohs(result);
@@ -1459,7 +1433,7 @@ void functions::decodeIsupNumber(const char *buffer, int length, isup_number_t &
   isupNumber.Digits = "";
   int byte;
 
-  for(register int k = 2; k < length; k ++) {
+  for(int k = 2; k < length; k ++) {
     byte = (buffer [k] & 0x0f);
     isupNumber.Digits += (byte >= 0 && byte <= 9) ? (byte + '0') : ((byte - 0xa) + 'a');
     byte = (buffer [k] & 0xf0) >> 4;
@@ -1538,7 +1512,7 @@ void functions::codeIsupNumber(const isup_number_t & isupNumber, bool calledOrCa
   //std::transform(dtlc.begin(), dtlc.end(), dtlc.begin(), std::tolower);
   const char *digits = dtlc.c_str();
 
-  for(register int k = 1; k < isupNumber.Digits.size(); k += 2) {
+  for(int k = 1; k < isupNumber.Digits.size(); k += 2) {
     if(isxdigit(byte = digits [k - 1]) == 0)
       throw anna::RuntimeException("functions::codeIsupNumber | Isup number 'Digits' field contains invalid digits (non hexadecimal)", ANNA_FILE_LOCATION);