git.gag.com Git - debian/gnuradio/blob - gruel/src/include/gruel/pmt.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2006,2009 Free Software Foundation, Inc.
   4  *
   5  * This file is part of GNU Radio
   6  *
   7  * GNU Radio 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 3, or (at your option)
  10  * any later version.
  11  *
  12  * GNU Radio is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with GNU Radio; see the file COPYING.  If not, write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 #ifndef INCLUDED_PMT_H
  24 #define INCLUDED_PMT_H
  25
  26 #include <boost/shared_ptr.hpp>
  27 #include <boost/any.hpp>
  28 #include <complex>
  29 #include <string>
  30 #include <stdint.h>
  31 #include <iosfwd>
  32 #include <stdexcept>
  33
  34 /*!
  35  * This file defines a polymorphic type and the operations on it.
  36  *
  37  * It draws heavily on the idea of scheme and lisp data types.
  38  * The interface parallels that in Guile 1.8, with the notable
  39  * exception that these objects are transparently reference counted.
  40  */
  41
  42 namespace pmt {
  43
  44 /*!
  45  * \brief base class of all pmt types
  46  */
  47 class pmt_base;
  48
  49 /*!
  50  * \brief typedef for shared pointer (transparent reference counting).
  51  * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
  52  */
  53 typedef boost::shared_ptr<pmt_base> pmt_t;
  54
  55
  56 class pmt_exception : public std::logic_error
  57 {
  58 public:
  59   pmt_exception(const std::string &msg, pmt_t obj);
  60 };
  61
  62 class pmt_wrong_type : public pmt_exception
  63 {
  64 public:
  65   pmt_wrong_type(const std::string &msg, pmt_t obj);
  66 };
  67
  68 class pmt_out_of_range : public pmt_exception
  69 {
  70 public:
  71   pmt_out_of_range(const std::string &msg, pmt_t obj);
  72 };
  73
  74 class pmt_notimplemented : public pmt_exception
  75 {
  76 public:
  77   pmt_notimplemented(const std::string &msg, pmt_t obj);
  78 };
  79
  80 /*
  81  * ------------------------------------------------------------------------
  82  * Booleans.  Two constants, #t and #f.
  83  *
  84  * In predicates, anything that is not #f is considered true.
  85  * I.e., there is a single false value, #f.
  86  * ------------------------------------------------------------------------
  87  */
  88 extern const pmt_t PMT_T;       //< \#t : boolean true constant
  89 extern const pmt_t PMT_F;       //< \#f : boolean false constant
  90
  91 //! Return true if obj is \#t or \#f, else return false.
  92 bool pmt_is_bool(pmt_t obj);
  93
  94 //! Return false if obj is \#f, else return true.
  95 bool pmt_is_true(pmt_t obj);
  96
  97 //! Return true if obj is \#f, else return true.
  98 bool pmt_is_false(pmt_t obj);
  99
 100 //! Return \#f is val is false, else return \#t.
 101 pmt_t pmt_from_bool(bool val);
 102
 103 //! Return true if val is PMT_T, return false when val is PMT_F,
 104 // else raise wrong_type exception.
 105 bool pmt_to_bool(pmt_t val);
 106
 107 /*
 108  * ------------------------------------------------------------------------
 109  *                             Symbols
 110  * ------------------------------------------------------------------------
 111  */
 112
 113 //! Return true if obj is a symbol, else false.
 114 bool pmt_is_symbol(const pmt_t& obj);
 115
 116 //! Return the symbol whose name is \p s.
 117 pmt_t pmt_string_to_symbol(const std::string &s);
 118
 119 //! Alias for pmt_string_to_symbol
 120 pmt_t pmt_intern(const std::string &s);
 121
 122
 123 /*!
 124  * If \p is a symbol, return the name of the symbol as a string.
 125  * Otherwise, raise the wrong_type exception.
 126  */
 127 const std::string pmt_symbol_to_string(const pmt_t& sym);
 128
 129 /*
 130  * ------------------------------------------------------------------------
 131  *           Numbers: we support integer, real and complex
 132  * ------------------------------------------------------------------------
 133  */
 134
 135 //! Return true if obj is any kind of number, else false.
 136 bool pmt_is_number(pmt_t obj);
 137
 138 /*
 139  * ------------------------------------------------------------------------
 140  *                             Integers
 141  * ------------------------------------------------------------------------
 142  */
 143
 144 //! Return true if \p x is an integer number, else false
 145 bool pmt_is_integer(pmt_t x);
 146
 147 //! Return the pmt value that represents the integer \p x.
 148 pmt_t pmt_from_long(long x);
 149
 150 /*!
 151  * \brief Convert pmt to long if possible.
 152  *
 153  * When \p x represents an exact integer that fits in a long,
 154  * return that integer.  Else raise an exception, either wrong_type
 155  * when x is not an exact integer, or out_of_range when it doesn't fit.
 156  */
 157 long pmt_to_long(pmt_t x);
 158
 159 /*
 160  * ------------------------------------------------------------------------
 161  *                              Reals
 162  * ------------------------------------------------------------------------
 163  */
 164
 165 /*
 166  * \brief Return true if \p obj is a real number, else false.
 167  */
 168 bool pmt_is_real(pmt_t obj);
 169
 170 //! Return the pmt value that represents double \p x.
 171 pmt_t pmt_from_double(double x);
 172
 173 /*!
 174  * \brief Convert pmt to double if possible.
 175  *
 176  * Returns the number closest to \p val that is representable
 177  * as a double.  The argument \p val must be a real or integer, otherwise
 178  * a wrong_type exception is raised.
 179  */
 180 double pmt_to_double(pmt_t x);
 181
 182 /*
 183  * ------------------------------------------------------------------------
 184  *                             Complex
 185  * ------------------------------------------------------------------------
 186  */
 187
 188 /*!
 189  * \brief return true if \p obj is a complex number, false otherwise.
 190  */
 191 bool pmt_is_complex(pmt_t obj);
 192
 193 //! Return a complex number constructed of the given real and imaginary parts.
 194 pmt_t pmt_make_rectangular(double re, double im);
 195
 196 /*!
 197  * If \p z is complex, real or integer, return the closest complex<double>.
 198  * Otherwise, raise the wrong_type exception.
 199  */
 200 std::complex<double> pmt_to_complex(pmt_t z);
 201
 202 /*
 203  * ------------------------------------------------------------------------
 204  *                              Pairs
 205  * ------------------------------------------------------------------------
 206  */
 207
 208 extern const pmt_t PMT_NIL;     //< the empty list
 209
 210 //! Return true if \p x is the empty list, otherwise return false.
 211 bool pmt_is_null(const pmt_t& x);
 212
 213 //! Return true if \p obj is a pair, else false.
 214 bool pmt_is_pair(const pmt_t& obj);
 215
 216 //! Return a newly allocated pair whose car is \p x and whose cdr is \p y.
 217 pmt_t pmt_cons(const pmt_t& x, const pmt_t& y);
 218
 219 //! If \p pair is a pair, return the car of the \p pair, otherwise raise wrong_type.
 220 pmt_t pmt_car(const pmt_t& pair);
 221
 222 //! If \p pair is a pair, return the cdr of the \p pair, otherwise raise wrong_type.
 223 pmt_t pmt_cdr(const pmt_t& pair);
 224
 225 //! Stores \p value in the car field of \p pair.
 226 void pmt_set_car(pmt_t pair, pmt_t value);
 227
 228 //! Stores \p value in the cdr field of \p pair.
 229 void pmt_set_cdr(pmt_t pair, pmt_t value);
 230
 231 pmt_t pmt_caar(pmt_t pair);
 232 pmt_t pmt_cadr(pmt_t pair);
 233 pmt_t pmt_cdar(pmt_t pair);
 234 pmt_t pmt_cddr(pmt_t pair);
 235 pmt_t pmt_caddr(pmt_t pair);
 236 pmt_t pmt_cadddr(pmt_t pair);
 237
 238 /*
 239  * ------------------------------------------------------------------------
 240  *                                Tuples
 241  *
 242  * Store a fixed number of objects.  Tuples are not modifiable, and thus
 243  * are excellent for use as messages.  Indexing is zero based.
 244  * Access time to an element is O(1).
 245  * ------------------------------------------------------------------------
 246  */
 247
 248 //! Return true if \p x is a tuple, othewise false.
 249 bool pmt_is_tuple(pmt_t x);
 250
 251 pmt_t pmt_make_tuple();
 252 pmt_t pmt_make_tuple(const pmt_t &e0);
 253 pmt_t pmt_make_tuple(const pmt_t &e0, const pmt_t &e1);
 254 pmt_t pmt_make_tuple(const pmt_t &e0, const pmt_t &e1, const pmt_t &e2);
 255 pmt_t pmt_make_tuple(const pmt_t &e0, const pmt_t &e1, const pmt_t &e2, const pmt_t &e3);
 256 pmt_t pmt_make_tuple(const pmt_t &e0, const pmt_t &e1, const pmt_t &e2, const pmt_t &e3, const pmt_t &e4);
 257 pmt_t pmt_make_tuple(const pmt_t &e0, const pmt_t &e1, const pmt_t &e2, const pmt_t &e3, const pmt_t &e4, const pmt_t &e5);
 258 pmt_t pmt_make_tuple(const pmt_t &e0, const pmt_t &e1, const pmt_t &e2, const pmt_t &e3, const pmt_t &e4, const pmt_t &e5, const pmt_t &e6);
 259 pmt_t pmt_make_tuple(const pmt_t &e0, const pmt_t &e1, const pmt_t &e2, const pmt_t &e3, const pmt_t &e4, const pmt_t &e5, const pmt_t &e6, const pmt_t &e7);
 260 pmt_t pmt_make_tuple(const pmt_t &e0, const pmt_t &e1, const pmt_t &e2, const pmt_t &e3, const pmt_t &e4, const pmt_t &e5, const pmt_t &e6, const pmt_t &e7, const pmt_t &e8);
 261 pmt_t pmt_make_tuple(const pmt_t &e0, const pmt_t &e1, const pmt_t &e2, const pmt_t &e3, const pmt_t &e4, const pmt_t &e5, const pmt_t &e6, const pmt_t &e7, const pmt_t &e8, const pmt_t &e9);
 262
 263 /*!
 264  * If \p x is a vector or proper list, return a tuple containing the elements of x
 265  */
 266 pmt_t pmt_to_tuple(const pmt_t &x);
 267
 268 /*!
 269  * Return the contents of position \p k of \p tuple.
 270  * \p k must be a valid index of \p tuple.
 271  */
 272 pmt_t pmt_tuple_ref(const pmt_t &tuple, size_t k);
 273
 274 /*
 275  * ------------------------------------------------------------------------
 276  *                             Vectors
 277  *
 278  * These vectors can hold any kind of objects.  Indexing is zero based.
 279  * ------------------------------------------------------------------------
 280  */
 281
 282 //! Return true if \p x is a vector, othewise false.
 283 bool pmt_is_vector(pmt_t x);
 284
 285 //! Make a vector of length \p k, with initial values set to \p fill
 286 pmt_t pmt_make_vector(size_t k, pmt_t fill);
 287
 288 /*!
 289  * Return the contents of position \p k of \p vector.
 290  * \p k must be a valid index of \p vector.
 291  */
 292 pmt_t pmt_vector_ref(pmt_t vector, size_t k);
 293
 294 //! Store \p obj in position \p k.
 295 void pmt_vector_set(pmt_t vector, size_t k, pmt_t obj);
 296
 297 //! Store \p fill in every position of \p vector
 298 void pmt_vector_fill(pmt_t vector, pmt_t fill);
 299
 300 /*!
 301  * <pre>
 302  * ------------------------------------------------------------------------
 303  *                     Uniform Numeric Vectors
 304  *
 305  * A uniform numeric vector is a vector whose elements are all of single
 306  * numeric type.  pmt offers uniform numeric vectors for signed and
 307  * unsigned 8-bit, 16-bit, 32-bit, and 64-bit integers, two sizes of
 308  * floating point values, and complex floating-point numbers of these
 309  * two sizes.  Indexing is zero based.
 310  *
 311  * The names of the functions include these tags in their names:
 312  *
 313  *    u8  unsigned 8-bit integers
 314  *    s8  signed 8-bit integers
 315  *   u16  unsigned 16-bit integers
 316  *   s16  signed 16-bit integers
 317  *   u32  unsigned 32-bit integers
 318  *   s32  signed 32-bit integers
 319  *   u64  unsigned 64-bit integers
 320  *   s64  signed 64-bit integers
 321  *   f32  the C++ type float
 322  *   f64  the C++ type double
 323  *   c32  the C++ type complex<float>
 324  *   c64  the C++ type complex<double>
 325  * ------------------------------------------------------------------------
 326  * </pre>
 327  */
 328
 329 //! true if \p x is any kind of uniform numeric vector
 330 bool pmt_is_uniform_vector(pmt_t x);
 331
 332 bool pmt_is_u8vector(pmt_t x);
 333 bool pmt_is_s8vector(pmt_t x);
 334 bool pmt_is_u16vector(pmt_t x);
 335 bool pmt_is_s16vector(pmt_t x);
 336 bool pmt_is_u32vector(pmt_t x);
 337 bool pmt_is_s32vector(pmt_t x);
 338 bool pmt_is_u64vector(pmt_t x);
 339 bool pmt_is_s64vector(pmt_t x);
 340 bool pmt_is_f32vector(pmt_t x);
 341 bool pmt_is_f64vector(pmt_t x);
 342 bool pmt_is_c32vector(pmt_t x);
 343 bool pmt_is_c64vector(pmt_t x);
 344
 345 pmt_t pmt_make_u8vector(size_t k, uint8_t fill);
 346 pmt_t pmt_make_s8vector(size_t k, int8_t fill);
 347 pmt_t pmt_make_u16vector(size_t k, uint16_t fill);
 348 pmt_t pmt_make_s16vector(size_t k, int16_t fill);
 349 pmt_t pmt_make_u32vector(size_t k, uint32_t fill);
 350 pmt_t pmt_make_s32vector(size_t k, int32_t fill);
 351 pmt_t pmt_make_u64vector(size_t k, uint64_t fill);
 352 pmt_t pmt_make_s64vector(size_t k, int64_t fill);
 353 pmt_t pmt_make_f32vector(size_t k, float fill);
 354 pmt_t pmt_make_f64vector(size_t k, double fill);
 355 pmt_t pmt_make_c32vector(size_t k, std::complex<float> fill);
 356 pmt_t pmt_make_c64vector(size_t k, std::complex<double> fill);
 357
 358 pmt_t pmt_init_u8vector(size_t k, const uint8_t *data);
 359 pmt_t pmt_init_s8vector(size_t k, const int8_t *data);
 360 pmt_t pmt_init_u16vector(size_t k, const uint16_t *data);
 361 pmt_t pmt_init_s16vector(size_t k, const int16_t *data);
 362 pmt_t pmt_init_u32vector(size_t k, const uint32_t *data);
 363 pmt_t pmt_init_s32vector(size_t k, const int32_t *data);
 364 pmt_t pmt_init_u64vector(size_t k, const uint64_t *data);
 365 pmt_t pmt_init_s64vector(size_t k, const int64_t *data);
 366 pmt_t pmt_init_f32vector(size_t k, const float *data);
 367 pmt_t pmt_init_f64vector(size_t k, const double *data);
 368 pmt_t pmt_init_c32vector(size_t k, const std::complex<float> *data);
 369 pmt_t pmt_init_c64vector(size_t k, const std::complex<double> *data);
 370
 371 uint8_t  pmt_u8vector_ref(pmt_t v, size_t k);
 372 int8_t   pmt_s8vector_ref(pmt_t v, size_t k);
 373 uint16_t pmt_u16vector_ref(pmt_t v, size_t k);
 374 int16_t  pmt_s16vector_ref(pmt_t v, size_t k);
 375 uint32_t pmt_u32vector_ref(pmt_t v, size_t k);
 376 int32_t  pmt_s32vector_ref(pmt_t v, size_t k);
 377 uint64_t pmt_u64vector_ref(pmt_t v, size_t k);
 378 int64_t  pmt_s64vector_ref(pmt_t v, size_t k);
 379 float    pmt_f32vector_ref(pmt_t v, size_t k);
 380 double   pmt_f64vector_ref(pmt_t v, size_t k);
 381 std::complex<float>  pmt_c32vector_ref(pmt_t v, size_t k);
 382 std::complex<double> pmt_c64vector_ref(pmt_t v, size_t k);
 383
 384 void pmt_u8vector_set(pmt_t v, size_t k, uint8_t x);  //< v[k] = x
 385 void pmt_s8vector_set(pmt_t v, size_t k, int8_t x);
 386 void pmt_u16vector_set(pmt_t v, size_t k, uint16_t x);
 387 void pmt_s16vector_set(pmt_t v, size_t k, int16_t x);
 388 void pmt_u32vector_set(pmt_t v, size_t k, uint32_t x);
 389 void pmt_s32vector_set(pmt_t v, size_t k, int32_t x);
 390 void pmt_u64vector_set(pmt_t v, size_t k, uint64_t x);
 391 void pmt_s64vector_set(pmt_t v, size_t k, int64_t x);
 392 void pmt_f32vector_set(pmt_t v, size_t k, float x);
 393 void pmt_f64vector_set(pmt_t v, size_t k, double x);
 394 void pmt_c32vector_set(pmt_t v, size_t k, std::complex<float> x);
 395 void pmt_c64vector_set(pmt_t v, size_t k, std::complex<double> x);
 396
 397 // Return const pointers to the elements
 398
 399 const void *pmt_uniform_vector_elements(pmt_t v, size_t &len);  //< works with any; len is in bytes
 400
 401 const uint8_t  *pmt_u8vector_elements(pmt_t v, size_t &len);  //< len is in elements
 402 const int8_t   *pmt_s8vector_elements(pmt_t v, size_t &len);  //< len is in elements
 403 const uint16_t *pmt_u16vector_elements(pmt_t v, size_t &len); //< len is in elements
 404 const int16_t  *pmt_s16vector_elements(pmt_t v, size_t &len); //< len is in elements
 405 const uint32_t *pmt_u32vector_elements(pmt_t v, size_t &len); //< len is in elements
 406 const int32_t  *pmt_s32vector_elements(pmt_t v, size_t &len); //< len is in elements
 407 const uint64_t *pmt_u64vector_elements(pmt_t v, size_t &len); //< len is in elements
 408 const int64_t  *pmt_s64vector_elements(pmt_t v, size_t &len); //< len is in elements
 409 const float    *pmt_f32vector_elements(pmt_t v, size_t &len); //< len is in elements
 410 const double   *pmt_f64vector_elements(pmt_t v, size_t &len); //< len is in elements
 411 const std::complex<float>  *pmt_c32vector_elements(pmt_t v, size_t &len); //< len is in elements
 412 const std::complex<double> *pmt_c64vector_elements(pmt_t v, size_t &len); //< len is in elements
 413
 414 // Return non-const pointers to the elements
 415
 416 void *pmt_uniform_vector_writable_elements(pmt_t v, size_t &len);  //< works with any; len is in bytes
 417
 418 uint8_t  *pmt_u8vector_writable_elements(pmt_t v, size_t &len);  //< len is in elements
 419 int8_t   *pmt_s8vector_writable_elements(pmt_t v, size_t &len);  //< len is in elements
 420 uint16_t *pmt_u16vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
 421 int16_t  *pmt_s16vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
 422 uint32_t *pmt_u32vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
 423 int32_t  *pmt_s32vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
 424 uint64_t *pmt_u64vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
 425 int64_t  *pmt_s64vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
 426 float    *pmt_f32vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
 427 double   *pmt_f64vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
 428 std::complex<float>  *pmt_c32vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
 429 std::complex<double> *pmt_c64vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
 430
 431 /*
 432  * ------------------------------------------------------------------------
 433  *         Dictionary (a.k.a associative array, hash, map)
 434  * ------------------------------------------------------------------------
 435  */
 436
 437 //! Return true if \p obj is a dictionary
 438 bool pmt_is_dict(pmt_t obj);
 439
 440 //! make an empty dictionary
 441 pmt_t pmt_make_dict();
 442
 443 //! dict[key] = value
 444 void  pmt_dict_set(pmt_t dict, pmt_t key, pmt_t value);
 445
 446 //! Return true if \p key exists in \p dict
 447 bool  pmt_dict_has_key(pmt_t dict, pmt_t key);
 448
 449 //! If \p key exists in \p dict, return associated value; otherwise return \p not_found.
 450 pmt_t pmt_dict_ref(pmt_t dict, pmt_t key, pmt_t not_found);
 451
 452 //! Return list of (key . value) pairs
 453 pmt_t pmt_dict_items(pmt_t dict);
 454
 455 //! Return list of keys
 456 pmt_t pmt_dict_keys(pmt_t dict);
 457
 458 //! Return list of values
 459 pmt_t pmt_dict_values(pmt_t dict);
 460
 461 /*
 462  * ------------------------------------------------------------------------
 463  *   Any (wraps boost::any -- can be used to wrap pretty much anything)
 464  *
 465  * Cannot be serialized or used across process boundaries.
 466  * See http://www.boost.org/doc/html/any.html
 467  * ------------------------------------------------------------------------
 468  */
 469
 470 //! Return true if \p obj is an any
 471 bool pmt_is_any(pmt_t obj);
 472
 473 //! make an any
 474 pmt_t pmt_make_any(const boost::any &any);
 475
 476 //! Return underlying boost::any
 477 boost::any pmt_any_ref(pmt_t obj);
 478
 479 //! Store \p any in \p obj
 480 void pmt_any_set(pmt_t obj, const boost::any &any);
 481
 482
 483 /*
 484  * ------------------------------------------------------------------------
 485  *                        General functions
 486  * ------------------------------------------------------------------------
 487  */
 488
 489 //! Return true if x and y are the same object; otherwise return false.
 490 bool pmt_eq(const pmt_t& x, const pmt_t& y);
 491
 492 /*!
 493  * \brief Return true if x and y should normally be regarded as the same object, else false.
 494  *
 495  * <pre>
 496  * eqv returns true if:
 497  *   x and y are the same object.
 498  *   x and y are both \#t or both \#f.
 499  *   x and y are both symbols and their names are the same.
 500  *   x and y are both numbers, and are numerically equal.
 501  *   x and y are both the empty list (nil).
 502  *   x and y are pairs or vectors that denote same location in store.
 503  * </pre>
 504  */
 505 bool pmt_eqv(const pmt_t& x, const pmt_t& y);
 506
 507 /*!
 508  * pmt_equal recursively compares the contents of pairs and vectors,
 509  * applying pmt_eqv on other objects such as numbers and symbols.
 510  * pmt_equal may fail to terminate if its arguments are circular data
 511  * structures.
 512  */
 513 bool pmt_equal(const pmt_t& x, const pmt_t& y);
 514
 515
 516 //! Return the number of elements in v
 517 size_t pmt_length(const pmt_t& v);
 518
 519 /*!
 520  * \brief Find the first pair in \p alist whose car field is \p obj
 521  *  and return that pair.
 522  *
 523  * \p alist (for "association list") must be a list of pairs.  If no pair
 524  * in \p alist has \p obj as its car then \#f is returned.
 525  * Uses pmt_eq to compare \p obj with car fields of the pairs in \p alist.
 526  */
 527 pmt_t pmt_assq(pmt_t obj, pmt_t alist);
 528
 529 /*!
 530  * \brief Find the first pair in \p alist whose car field is \p obj
 531  *  and return that pair.
 532  *
 533  * \p alist (for "association list") must be a list of pairs.  If no pair
 534  * in \p alist has \p obj as its car then \#f is returned.
 535  * Uses pmt_eqv to compare \p obj with car fields of the pairs in \p alist.
 536  */
 537 pmt_t pmt_assv(pmt_t obj, pmt_t alist);
 538
 539 /*!
 540  * \brief Find the first pair in \p alist whose car field is \p obj
 541  *  and return that pair.
 542  *
 543  * \p alist (for "association list") must be a list of pairs.  If no pair
 544  * in \p alist has \p obj as its car then \#f is returned.
 545  * Uses pmt_equal to compare \p obj with car fields of the pairs in \p alist.
 546  */
 547 pmt_t pmt_assoc(pmt_t obj, pmt_t alist);
 548
 549 /*!
 550  * \brief Apply \p proc element-wise to the elements of list and returns
 551  * a list of the results, in order.
 552  *
 553  * \p list must be a list.  The dynamic order in which \p proc is
 554  * applied to the elements of \p list is unspecified.
 555  */
 556 pmt_t pmt_map(pmt_t proc(const pmt_t&), pmt_t list);
 557
 558 /*!
 559  * \brief reverse \p list.
 560  *
 561  * \p list must be a proper list.
 562  */
 563 pmt_t pmt_reverse(pmt_t list);
 564
 565 /*!
 566  * \brief destructively reverse \p list.
 567  *
 568  * \p list must be a proper list.
 569  */
 570 pmt_t pmt_reverse_x(pmt_t list);
 571
 572 /*!
 573  * \brief (acons x y a) == (cons (cons x y) a)
 574  */
 575 inline static pmt_t
 576 pmt_acons(pmt_t x, pmt_t y, pmt_t a)
 577 {
 578   return pmt_cons(pmt_cons(x, y), a);
 579 }
 580
 581 /*!
 582  * \brief locates \p nth element of \n list where the car is the 'zeroth' element.
 583  */
 584 pmt_t pmt_nth(size_t n, pmt_t list);
 585
 586 /*!
 587  * \brief returns the tail of \p list that would be obtained by calling
 588  * cdr \p n times in succession.
 589  */
 590 pmt_t pmt_nthcdr(size_t n, pmt_t list);
 591
 592 /*!
 593  * \brief Return the first sublist of \p list whose car is \p obj.
 594  * If \p obj does not occur in \p list, then \#f is returned.
 595  * pmt_memq use pmt_eq to compare \p obj with the elements of \p list.
 596  */
 597 pmt_t pmt_memq(pmt_t obj, pmt_t list);
 598
 599 /*!
 600  * \brief Return the first sublist of \p list whose car is \p obj.
 601  * If \p obj does not occur in \p list, then \#f is returned.
 602  * pmt_memv use pmt_eqv to compare \p obj with the elements of \p list.
 603  */
 604 pmt_t pmt_memv(pmt_t obj, pmt_t list);
 605
 606 /*!
 607  * \brief Return the first sublist of \p list whose car is \p obj.
 608  * If \p obj does not occur in \p list, then \#f is returned.
 609  * pmt_member use pmt_equal to compare \p obj with the elements of \p list.
 610  */
 611 pmt_t pmt_member(pmt_t obj, pmt_t list);
 612
 613 /*!
 614  * \brief Return true if every element of \p list1 appears in \p list2, and false otherwise.
 615  * Comparisons are done with pmt_eqv.
 616  */
 617 bool pmt_subsetp(pmt_t list1, pmt_t list2);
 618
 619 /*!
 620  * \brief Return a list of length 1 containing \p x1
 621  */
 622 pmt_t pmt_list1(const pmt_t& x1);
 623
 624 /*!
 625  * \brief Return a list of length 2 containing \p x1, \p x2
 626  */
 627 pmt_t pmt_list2(const pmt_t& x1, const pmt_t& x2);
 628
 629 /*!
 630  * \brief Return a list of length 3 containing \p x1, \p x2, \p x3
 631  */
 632 pmt_t pmt_list3(const pmt_t& x1, const pmt_t& x2, const pmt_t& x3);
 633
 634 /*!
 635  * \brief Return a list of length 4 containing \p x1, \p x2, \p x3, \p x4
 636  */
 637 pmt_t pmt_list4(const pmt_t& x1, const pmt_t& x2, const pmt_t& x3, const pmt_t& x4);
 638
 639 /*!
 640  * \brief Return a list of length 5 containing \p x1, \p x2, \p x3, \p x4, \p x5
 641  */
 642 pmt_t pmt_list5(const pmt_t& x1, const pmt_t& x2, const pmt_t& x3, const pmt_t& x4, const pmt_t& x5);
 643
 644 /*!
 645  * \brief Return a list of length 6 containing \p x1, \p x2, \p x3, \p x4, \p
 646  * x5, \p x6
 647  */
 648 pmt_t pmt_list6(const pmt_t& x1, const pmt_t& x2, const pmt_t& x3, const pmt_t& x4, const pmt_t& x5, const pmt_t& x6);
 649
 650 /*!
 651  * \brief Return \p list with \p item added to it.
 652  */
 653 pmt_t pmt_list_add(pmt_t list, const pmt_t& item);
 654
 655
 656 /*
 657  * ------------------------------------------------------------------------
 658  *                           read / write
 659  * ------------------------------------------------------------------------
 660  */
 661 extern const pmt_t PMT_EOF;     //< The end of file object
 662
 663 //! return true if obj is the EOF object, otherwise return false.
 664 bool pmt_is_eof_object(pmt_t obj);
 665
 666 /*!
 667  * read converts external representations of pmt objects into the
 668  * objects themselves.  Read returns the next object parsable from
 669  * the given input port, updating port to point to the first
 670  * character past the end of the external representation of the
 671  * object.
 672  *
 673  * If an end of file is encountered in the input before any
 674  * characters are found that can begin an object, then an end of file
 675  * object is returned.   The port remains open, and further attempts
 676  * to read will also return an end of file object.  If an end of file
 677  * is encountered after the beginning of an object's external
 678  * representation, but the external representation is incomplete and
 679  * therefore not parsable, an error is signaled.
 680  */
 681 pmt_t pmt_read(std::istream &port);
 682
 683 /*!
 684  * Write a written representation of \p obj to the given \p port.
 685  */
 686 void pmt_write(pmt_t obj, std::ostream &port);
 687
 688 /*!
 689  * Return a string representation of \p obj.
 690  * This is the same output as would be generated by pmt_write.
 691  */
 692 std::string pmt_write_string(pmt_t obj);
 693
 694
 695 std::ostream& operator<<(std::ostream &os, pmt_t obj);
 696
 697
 698 /*
 699  * ------------------------------------------------------------------------
 700  *                    portable byte stream representation
 701  * ------------------------------------------------------------------------
 702  */
 703 /*!
 704  * \brief Write portable byte-serial representation of \p obj to \p sink
 705  */
 706 bool pmt_serialize(pmt_t obj, std::streambuf &sink);
 707
 708 /*!
 709  * \brief Create obj from portable byte-serial representation
 710  */
 711 pmt_t pmt_deserialize(std::streambuf &source);
 712
 713
 714 void pmt_dump_sizeof(); // debugging
 715
 716 } /* namespace pmt */
 717
 718 #endif /* INCLUDED_PMT_H */