ginac/archive.cpp

   1 /** @file archive.cpp
   2  *
   3  *  Archiving of GiNaC expressions. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2011 Johannes Gutenberg University Mainz, Germany
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  21  */
  22
  23 #include "archive.h"
  24 #include "registrar.h"
  25 #include "ex.h"
  26 #include "lst.h"
  27 #ifdef HAVE_CONFIG_H
  28 #include "config.h"
  29 #endif
  30 #include "tostring.h"
  31
  32 #include <iostream>
  33 #include <stdexcept>
  34
  35 namespace GiNaC {
  36
  37
  38 void archive::archive_ex(const ex &e, const char *name)
  39 {
  40         // Create root node (which recursively archives the whole expression tree)
  41         // and add it to the archive
  42         archive_node_id id = add_node(archive_node(*this, e));
  43
  44         // Add root node ID to list of archived expressions
  45         archived_ex ae = archived_ex(atomize(name), id);
  46         exprs.push_back(ae);
  47 }
  48
  49
  50 /** Add archive_node to archive if the corresponding expression is
  51  *  not already archived.
  52  *  @return ID of archived node */
  53 archive_node_id archive::add_node(const archive_node &n)
  54 {
  55         // Look if expression is known to be in some node already.
  56         if (n.has_ex()) {
  57                 mapit i = exprtable.find(n.get_ex());
  58                 if (i != exprtable.end())
  59                         return i->second;
  60                 nodes.push_back(n);
  61                 exprtable[n.get_ex()] = nodes.size() - 1;
  62                 return nodes.size() - 1;
  63         }
  64
  65         // Not found, add archive_node to nodes vector
  66         nodes.push_back(n);
  67         return nodes.size()-1;
  68 }
  69
  70
  71 /** Retrieve archive_node by ID. */
  72 archive_node &archive::get_node(archive_node_id id)
  73 {
  74         if (id >= nodes.size())
  75                 throw (std::range_error("archive::get_node(): archive node ID out of range"));
  76
  77         return nodes[id];
  78 }
  79
  80
  81 ex archive::unarchive_ex(const lst &sym_lst, const char *name) const
  82 {
  83         // Find root node
  84         std::string name_string = name;
  85         archive_atom id = atomize(name_string);
  86         std::vector<archived_ex>::const_iterator i = exprs.begin(), iend = exprs.end();
  87         while (i != iend) {
  88                 if (i->name == id)
  89                         goto found;
  90                 i++;
  91         }
  92         throw (std::runtime_error("expression with name '" + name_string + "' not found in archive"));
  93
  94 found:
  95         // Recursively unarchive all nodes, starting at the root node
  96         lst sym_lst_copy = sym_lst;
  97         return nodes[i->root].unarchive(sym_lst_copy);
  98 }
  99
 100 ex archive::unarchive_ex(const lst &sym_lst, unsigned index) const
 101 {
 102         if (index >= exprs.size())
 103                 throw (std::range_error("index of archived expression out of range"));
 104
 105         // Recursively unarchive all nodes, starting at the root node
 106         lst sym_lst_copy = sym_lst;
 107         return nodes[exprs[index].root].unarchive(sym_lst_copy);
 108 }
 109
 110 ex archive::unarchive_ex(const lst &sym_lst, std::string &name, unsigned index) const
 111 {
 112         if (index >= exprs.size())
 113                 throw (std::range_error("index of archived expression out of range"));
 114
 115         // Return expression name
 116         name = unatomize(exprs[index].name);
 117
 118         // Recursively unarchive all nodes, starting at the root node
 119         lst sym_lst_copy = sym_lst;
 120         return nodes[exprs[index].root].unarchive(sym_lst_copy);
 121 }
 122
 123 unsigned archive::num_expressions() const
 124 {
 125         return exprs.size();
 126 }
 127
 128 const archive_node &archive::get_top_node(unsigned index) const
 129 {
 130         if (index >= exprs.size())
 131                 throw (std::range_error("index of archived expression out of range"));
 132
 133         return nodes[exprs[index].root];
 134 }
 135
 136
 137 /*
 138  *  Archive file format
 139  *
 140  *   - 4 bytes signature 'GARC'
 141  *   - unsigned version number
 142  *   - unsigned number of atoms
 143  *      - atom strings (each zero-terminated)
 144  *   - unsigned number of expressions
 145  *      - unsigned name atom
 146  *      - unsigned root node ID
 147  *   - unsigned number of nodes
 148  *      - unsigned number of properties
 149  *        - unsigned containing type (PTYPE_*) in its lower 3 bits and
 150  *          name atom in the upper bits
 151  *        - unsigned property value
 152  *
 153  *  Unsigned quantities are stored in a compressed format:
 154  *   - numbers in the range 0x00..0x7f are stored verbatim (1 byte)
 155  *   - numbers larger than 0x7f are stored in 7-bit packets (1 byte per
 156  *     packet), starting with the LSBs; all bytes except the last one have
 157  *     their upper bit set
 158  *
 159  *  Examples:
 160  *   0x00           =   0x00
 161  *    ..                 ..
 162  *   0x7f           =   0x7f
 163  *   0x80 0x01      =   0x80
 164  *    ..   ..            ..
 165  *   0xff 0x01      =   0xff
 166  *   0x80 0x02      =  0x100
 167  *    ..   ..            ..
 168  *   0xff 0x02      =  0x17f
 169  *   0x80 0x03      =  0x180
 170  *    ..   ..            ..
 171  *   0xff 0x7f      = 0x3fff
 172  *   0x80 0x80 0x01 = 0x4000
 173  *    ..   ..   ..       ..
 174  */
 175
 176 /** Write unsigned integer quantity to stream. */
 177 static void write_unsigned(std::ostream &os, unsigned val)
 178 {
 179         while (val >= 0x80) {
 180                 os.put((val & 0x7f) | 0x80);
 181                 val >>= 7;
 182         }
 183         os.put(val);
 184 }
 185
 186 /** Read unsigned integer quantity from stream. */
 187 static unsigned read_unsigned(std::istream &is)
 188 {
 189         unsigned char b;
 190         unsigned ret = 0;
 191         unsigned shift = 0;
 192         do {
 193                 char b2;
 194                 is.get(b2);
 195                 b = b2;
 196                 ret |= (b & 0x7f) << shift;
 197                 shift += 7;
 198         } while (b & 0x80);
 199         return ret;
 200 }
 201
 202 /** Write archive_node to binary data stream. */
 203 std::ostream &operator<<(std::ostream &os, const archive_node &n)
 204 {
 205         // Write properties
 206         unsigned num_props = n.props.size();
 207         write_unsigned(os, num_props);
 208         for (unsigned i=0; i<num_props; i++) {
 209                 write_unsigned(os, n.props[i].type | (n.props[i].name << 3));
 210                 write_unsigned(os, n.props[i].value);
 211         }
 212         return os;
 213 }
 214
 215 /** Write archive to binary data stream. */
 216 std::ostream &operator<<(std::ostream &os, const archive &ar)
 217 {
 218         // Write header
 219         os.put('G');    // Signature
 220         os.put('A');
 221         os.put('R');
 222         os.put('C');
 223         write_unsigned(os, ARCHIVE_VERSION);
 224
 225         // Write atoms
 226         unsigned num_atoms = ar.atoms.size();
 227         write_unsigned(os, num_atoms);
 228         for (unsigned i=0; i<num_atoms; i++)
 229                 os << ar.atoms[i] << std::ends;
 230
 231         // Write expressions
 232         unsigned num_exprs = ar.exprs.size();
 233         write_unsigned(os, num_exprs);
 234         for (unsigned i=0; i<num_exprs; i++) {
 235                 write_unsigned(os, ar.exprs[i].name);
 236                 write_unsigned(os, ar.exprs[i].root);
 237         }
 238
 239         // Write nodes
 240         unsigned num_nodes = ar.nodes.size();
 241         write_unsigned(os, num_nodes);
 242         for (unsigned i=0; i<num_nodes; i++)
 243                 os << ar.nodes[i];
 244         return os;
 245 }
 246
 247 /** Read archive_node from binary data stream. */
 248 std::istream &operator>>(std::istream &is, archive_node &n)
 249 {
 250         // Read properties
 251         unsigned num_props = read_unsigned(is);
 252         n.props.resize(num_props);
 253         for (unsigned i=0; i<num_props; i++) {
 254                 unsigned name_type = read_unsigned(is);
 255                 n.props[i].type = (archive_node::property_type)(name_type & 7);
 256                 n.props[i].name = name_type >> 3;
 257                 n.props[i].value = read_unsigned(is);
 258         }
 259         return is;
 260 }
 261
 262 /** Read archive from binary data stream. */
 263 std::istream &operator>>(std::istream &is, archive &ar)
 264 {
 265         // Read header
 266         char c1, c2, c3, c4;
 267         is.get(c1); is.get(c2); is.get(c3); is.get(c4);
 268         if (c1 != 'G' || c2 != 'A' || c3 != 'R' || c4 != 'C')
 269                 throw (std::runtime_error("not a GiNaC archive (signature not found)"));
 270         unsigned version = read_unsigned(is);
 271         if (version > ARCHIVE_VERSION || version < ARCHIVE_VERSION - ARCHIVE_AGE)
 272                 throw (std::runtime_error("archive version " + ToString(version) + " cannot be read by this GiNaC library (which supports versions " + ToString(ARCHIVE_VERSION-ARCHIVE_AGE) + " thru " + ToString(ARCHIVE_VERSION)));
 273
 274         // Read atoms
 275         unsigned num_atoms = read_unsigned(is);
 276         ar.atoms.resize(num_atoms);
 277         for (unsigned i=0; i<num_atoms; i++) {
 278                 getline(is, ar.atoms[i], '\0');
 279                 ar.inverse_atoms[ar.atoms[i]] = i;
 280         }
 281
 282         // Read expressions
 283         unsigned num_exprs = read_unsigned(is);
 284         ar.exprs.resize(num_exprs);
 285         for (unsigned i=0; i<num_exprs; i++) {
 286                 archive_atom name = read_unsigned(is);
 287                 archive_node_id root = read_unsigned(is);
 288                 ar.exprs[i] = archive::archived_ex(name, root);
 289         }
 290
 291         // Read nodes
 292         unsigned num_nodes = read_unsigned(is);
 293         ar.nodes.resize(num_nodes, ar);
 294         for (unsigned i=0; i<num_nodes; i++)
 295                 is >> ar.nodes[i];
 296         return is;
 297 }
 298
 299
 300 /** Atomize a string (i.e. convert it into an ID number that uniquely
 301  *  represents the string). */
 302 archive_atom archive::atomize(const std::string &s) const
 303 {
 304         // Search for string in inverse_atoms map.
 305         inv_at_cit i = inverse_atoms.find(s);
 306         if (i!=inverse_atoms.end())
 307                 return i->second;
 308
 309         // Not found, add to atoms vector
 310         archive_atom id = atoms.size();
 311         atoms.push_back(s);
 312         inverse_atoms[s] = id;
 313         return id;
 314 }
 315
 316 /** Unatomize a string (i.e. convert the ID number back to the string). */
 317 const std::string &archive::unatomize(archive_atom id) const
 318 {
 319         if (id >= atoms.size())
 320                 throw (std::range_error("archive::unatomizee(): atom ID out of range"));
 321
 322         return atoms[id];
 323 }
 324
 325
 326 /** Assignment operator of archive_node. */
 327 const archive_node &archive_node::operator=(const archive_node &other)
 328 {
 329         if (this != &other) {
 330                 // archive &a member doesn't get copied
 331                 props = other.props;
 332                 has_expression = other.has_expression;
 333                 e = other.e;
 334         }
 335         return *this;
 336 }
 337
 338
 339 /** Recursively construct archive node from expression. */
 340 archive_node::archive_node(archive &ar, const ex &expr)
 341   : a(ar), has_expression(true), e(expr)
 342 {
 343         expr.bp->archive(*this);
 344 }
 345
 346
 347 /** Check if the archive_node stores the same expression as another
 348  *  archive_node.
 349  *  @return "true" if expressions are the same */
 350 bool archive_node::has_same_ex_as(const archive_node &other) const
 351 {
 352         if (!has_expression || !other.has_expression)
 353                 return false;
 354         return e.bp == other.e.bp;
 355 }
 356
 357 archive_node::archive_node_cit
 358                 archive_node::find_first(const std::string &name) const
 359 {
 360         archive_atom name_atom = a.atomize(name);
 361         for (archive_node_cit i=props.begin(); i!=props.end(); ++i)
 362                 if (i->name == name_atom)
 363                         return i;
 364         return props.end();;
 365 }
 366
 367 archive_node::archive_node_cit
 368                 archive_node::find_last(const std::string &name) const
 369 {
 370         archive_atom name_atom = a.atomize(name);
 371         for (archive_node_cit i=props.end(); i!=props.begin();) {
 372                 --i;
 373                 if (i->name == name_atom)
 374                         return i;
 375         }
 376         return props.end();
 377 }
 378
 379 void archive_node::add_bool(const std::string &name, bool value)
 380 {
 381         props.push_back(property(a.atomize(name), PTYPE_BOOL, value));
 382 }
 383
 384 void archive_node::add_unsigned(const std::string &name, unsigned value)
 385 {
 386         props.push_back(property(a.atomize(name), PTYPE_UNSIGNED, value));
 387 }
 388
 389 void archive_node::add_string(const std::string &name, const std::string &value)
 390 {
 391         props.push_back(property(a.atomize(name), PTYPE_STRING, a.atomize(value)));
 392 }
 393
 394 void archive_node::add_ex(const std::string &name, const ex &value)
 395 {
 396         // Recursively create an archive_node and add its ID to the properties of this node
 397         archive_node_id id = a.add_node(archive_node(a, value));
 398         props.push_back(property(a.atomize(name), PTYPE_NODE, id));
 399 }
 400
 401
 402 bool archive_node::find_bool(const std::string &name, bool &ret, unsigned index) const
 403 {
 404         archive_atom name_atom = a.atomize(name);
 405         archive_node_cit i = props.begin(), iend = props.end();
 406         unsigned found_index = 0;
 407         while (i != iend) {
 408                 if (i->type == PTYPE_BOOL && i->name == name_atom) {
 409                         if (found_index == index) {
 410                                 ret = i->value;
 411                                 return true;
 412                         }
 413                         found_index++;
 414                 }
 415                 i++;
 416         }
 417         return false;
 418 }
 419
 420 bool archive_node::find_unsigned(const std::string &name, unsigned &ret, unsigned index) const
 421 {
 422         archive_atom name_atom = a.atomize(name);
 423         archive_node_cit i = props.begin(), iend = props.end();
 424         unsigned found_index = 0;
 425         while (i != iend) {
 426                 if (i->type == PTYPE_UNSIGNED && i->name == name_atom) {
 427                         if (found_index == index) {
 428                                 ret = i->value;
 429                                 return true;
 430                         }
 431                         found_index++;
 432                 }
 433                 i++;
 434         }
 435         return false;
 436 }
 437
 438 bool archive_node::find_string(const std::string &name, std::string &ret, unsigned index) const
 439 {
 440         archive_atom name_atom = a.atomize(name);
 441         archive_node_cit i = props.begin(), iend = props.end();
 442         unsigned found_index = 0;
 443         while (i != iend) {
 444                 if (i->type == PTYPE_STRING && i->name == name_atom) {
 445                         if (found_index == index) {
 446                                 ret = a.unatomize(i->value);
 447                                 return true;
 448                         }
 449                         found_index++;
 450                 }
 451                 i++;
 452         }
 453         return false;
 454 }
 455
 456 void archive_node::find_ex_by_loc(archive_node_cit loc, ex &ret, lst &sym_lst)
 457                 const
 458 {
 459         ret = a.get_node(loc->value).unarchive(sym_lst);
 460 }
 461
 462 bool archive_node::find_ex(const std::string &name, ex &ret, lst &sym_lst, unsigned index) const
 463 {
 464         archive_atom name_atom = a.atomize(name);
 465         archive_node_cit i = props.begin(), iend = props.end();
 466         unsigned found_index = 0;
 467         while (i != iend) {
 468                 if (i->type == PTYPE_NODE && i->name == name_atom) {
 469                         if (found_index == index) {
 470                                 ret = a.get_node(i->value).unarchive(sym_lst);
 471                                 return true;
 472                         }
 473                         found_index++;
 474                 }
 475                 i++;
 476         }
 477         return false;
 478 }
 479
 480 const archive_node &archive_node::find_ex_node(const std::string &name, unsigned index) const
 481 {
 482         archive_atom name_atom = a.atomize(name);
 483         archive_node_cit i = props.begin(), iend = props.end();
 484         unsigned found_index = 0;
 485         while (i != iend) {
 486                 if (i->type == PTYPE_NODE && i->name == name_atom) {
 487                         if (found_index == index)
 488                                 return a.get_node(i->value);
 489                         found_index++;
 490                 }
 491                 i++;
 492         }
 493         throw (std::runtime_error("property with name '" + name + "' not found in archive node"));
 494 }
 495
 496
 497 void archive_node::get_properties(propinfovector &v) const
 498 {
 499         v.clear();
 500         archive_node_cit i = props.begin(), iend = props.end();
 501         while (i != iend) {
 502                 property_type type = i->type;
 503                 std::string name = a.unatomize(i->name);
 504
 505                 propinfovector::iterator a = v.begin(), aend = v.end();
 506                 bool found = false;
 507                 while (a != aend) {
 508                         if (a->type == type && a->name == name) {
 509                                 a->count++;
 510                                 found = true;
 511                                 break;
 512                         }
 513                         ++a;
 514                 }
 515                 if (!found)
 516                         v.push_back(property_info(type, name));
 517                 i++;
 518         }
 519 }
 520
 521 static synthesize_func find_factory_fcn(const std::string& name)
 522 {
 523         static unarchive_table_t the_table;
 524         synthesize_func ret = the_table.find(name);
 525         return ret;
 526 }
 527
 528 /** Convert archive node to GiNaC expression. */
 529 ex archive_node::unarchive(lst &sym_lst) const
 530 {
 531         // Already unarchived? Then return cached unarchived expression.
 532         if (has_expression)
 533                 return e;
 534
 535         // Find instantiation function for class specified in node
 536         std::string class_name;
 537         if (!find_string("class", class_name))
 538                 throw (std::runtime_error("archive node contains no class name"));
 539
 540         // Call instantiation function
 541         synthesize_func factory_fcn = find_factory_fcn(class_name);
 542         ptr<basic> obj(factory_fcn());
 543         obj->setflag(status_flags::dynallocated);
 544         obj->read_archive(*this, sym_lst);
 545         e = ex(*obj);
 546         has_expression = true;
 547         return e;
 548 }
 549
 550 int unarchive_table_t::usecount = 0;
 551 unarchive_map_t* unarchive_table_t::unarch_map = 0;
 552
 553 unarchive_table_t::unarchive_table_t()
 554 {
 555         if (usecount == 0)
 556                 unarch_map = new unarchive_map_t();
 557         ++usecount;
 558 }
 559
 560 synthesize_func unarchive_table_t::find(const std::string& classname) const
 561 {
 562         unarchive_map_t::const_iterator i = unarch_map->find(classname);
 563         if (i != unarch_map->end())
 564                 return i->second;
 565         throw std::runtime_error(std::string("no unarchiving function for \"")
 566                         + classname + "\" class");
 567 }
 568
 569 void unarchive_table_t::insert(const std::string& classname, synthesize_func f)
 570 {
 571         if (unarch_map->find(classname) != unarch_map->end())
 572                 throw std::runtime_error(std::string("Class \"" + classname
 573                                         + "\" is already registered"));
 574         unarch_map->operator[](classname) = f;
 575 }
 576
 577 unarchive_table_t::~unarchive_table_t()
 578 {
 579         if (--usecount == 0)
 580                 delete unarch_map;
 581 }
 582
 583
 584 void archive::clear()
 585 {
 586         atoms.clear();
 587         inverse_atoms.clear();
 588         exprs.clear();
 589         nodes.clear();
 590         exprtable.clear();
 591 }
 592
 593
 594 /** Delete cached unarchived expressions in all archive_nodes (mainly for debugging). */
 595 void archive::forget()
 596 {
 597         for_each(nodes.begin(), nodes.end(), std::mem_fun_ref(&archive_node::forget));
 598 }
 599
 600 /** Delete cached unarchived expressions from node (for debugging). */
 601 void archive_node::forget()
 602 {
 603         has_expression = false;
 604         e = 0;
 605 }
 606
 607
 608 /** Print archive to stream in ugly raw format (for debugging). */
 609 void archive::printraw(std::ostream &os) const
 610 {
 611         // Dump atoms
 612         os << "Atoms:\n";
 613         {
 614                 std::vector<std::string>::const_iterator i = atoms.begin(), iend = atoms.end();
 615                 archive_atom id = 0;
 616                 while (i != iend) {
 617                         os << " " << id << " " << *i << std::endl;
 618                         i++; id++;
 619                 }
 620         }
 621         os << std::endl;
 622
 623         // Dump expressions
 624         os << "Expressions:\n";
 625         {
 626                 std::vector<archived_ex>::const_iterator i = exprs.begin(), iend = exprs.end();
 627                 unsigned index = 0;
 628                 while (i != iend) {
 629                         os << " " << index << " \"" << unatomize(i->name) << "\" root node " << i->root << std::endl;
 630                         i++; index++;
 631                 }
 632         }
 633         os << std::endl;
 634
 635         // Dump nodes
 636         os << "Nodes:\n";
 637         {
 638                 std::vector<archive_node>::const_iterator i = nodes.begin(), iend = nodes.end();
 639                 archive_node_id id = 0;
 640                 while (i != iend) {
 641                         os << " " << id << " ";
 642                         i->printraw(os);
 643                         i++; id++;
 644                 }
 645         }
 646 }
 647
 648 /** Output archive_node to stream in ugly raw format (for debugging). */
 649 void archive_node::printraw(std::ostream &os) const
 650 {
 651         // Dump cached unarchived expression
 652         if (has_expression)
 653                 os << "(basic * " << e.bp << " = " << e << ")\n";
 654         else
 655                 os << "\n";
 656
 657         // Dump properties
 658         archive_node_cit i = props.begin(), iend = props.end();
 659         while (i != iend) {
 660                 os << "  ";
 661                 switch (i->type) {
 662                         case PTYPE_BOOL: os << "bool"; break;
 663                         case PTYPE_UNSIGNED: os << "unsigned"; break;
 664                         case PTYPE_STRING: os << "string"; break;
 665                         case PTYPE_NODE: os << "node"; break;
 666                         default: os << "<unknown>"; break;
 667                 }
 668                 os << " \"" << a.unatomize(i->name) << "\" " << i->value << std::endl;
 669                 i++;
 670         }
 671 }
 672
 673 /** Create a dummy archive.  The intention is to fill archive_node's default
 674  *  ctor, which is currently a Cint-requirement. */
 675 archive* archive_node::dummy_ar_creator()
 676 {
 677         static archive* some_ar = new archive;
 678         return some_ar;
 679 }
 680
 681
 682 } // namespace GiNaC