*.c: Reformat docstrings.

[catacomb-python] / rand.c

diff --git a/rand.c b/rand.c
index b662fd5..5286472 100644 (file)
--- a/rand.c
+++ b/rand.c
@@ -27,14 +27,17 @@
 /*----- Header files ------------------------------------------------------*/
 
 #include "catacomb-python.h"
+PUBLIC_SYMBOLS;
 #include "algorithms.h"
+PRIVATE_SYMBOLS;
 
 /*----- Main code ---------------------------------------------------------*/
 
-PyTypeObject *grand_pytype, *truerand_pytype;
-PyTypeObject *lcrand_pytype, *fibrand_pytype;
-PyTypeObject *dsarand_pytype, *bbs_pytype, *bbspriv_pytype;
-PyTypeObject *sslprf_pytype, *tlsdx_pytype, *tlsprf_pytype;
+PyTypeObject *grand_pytype;
+static PyTypeObject *truerand_pytype;
+static PyTypeObject *lcrand_pytype, *fibrand_pytype;
+static PyTypeObject *dsarand_pytype, *bbs_pytype, *bbspriv_pytype;
+static PyTypeObject *sslprf_pytype, *tlsdx_pytype, *tlsprf_pytype;
 PyObject *rand_pyobj;
 
 static PyObject *gccrands_dict;
@@ -54,14 +57,14 @@ PyObject *grand_pywrap(grand *r, unsigned f)
   PyTypeObject *ty = grand_pytype;
   PyObject *ob;
 
-  if (strcmp(r->ops->name, "rand") == 0) ty = truerand_pytype;
-  else if (strcmp(r->ops->name, "lcrand") == 0) ty = lcrand_pytype;
-  else if (strcmp(r->ops->name, "fibrand") == 0) ty = fibrand_pytype;
-  else if (strcmp(r->ops->name, "dsarand") == 0) ty = dsarand_pytype;
-  else if (strcmp(r->ops->name, "bbs") == 0) ty = bbs_pytype;
-  else if (strcmp(r->ops->name, "sslprf") == 0) ty = sslprf_pytype;
-  else if (strcmp(r->ops->name, "tlsdx") == 0) ty = tlsdx_pytype;
-  else if (strcmp(r->ops->name, "tlsprf") == 0) ty = tlsprf_pytype;
+  if (STRCMP(r->ops->name, ==, "rand")) ty = truerand_pytype;
+  else if (STRCMP(r->ops->name, ==, "lcrand")) ty = lcrand_pytype;
+  else if (STRCMP(r->ops->name, ==, "fibrand")) ty = fibrand_pytype;
+  else if (STRCMP(r->ops->name, ==, "dsarand")) ty = dsarand_pytype;
+  else if (STRCMP(r->ops->name, ==, "bbs")) ty = bbs_pytype;
+  else if (STRCMP(r->ops->name, ==, "sslprf")) ty = sslprf_pytype;
+  else if (STRCMP(r->ops->name, ==, "tlsdx")) ty = tlsdx_pytype;
+  else if (STRCMP(r->ops->name, ==, "tlsprf")) ty = tlsprf_pytype;
   else if ((ob = PyDict_GetItemString(gccrands_dict, r->ops->name)) != 0)
     ty = (PyTypeObject *)ob;
   return (grand_dopywrap(ty, r, f));
@@ -306,7 +309,7 @@ static PyTypeObject grand_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Generic random number source.",
+  "Generic random number source.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -363,7 +366,7 @@ static PyTypeObject lcrand_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"LCRand([seed = 0]): linear congruential generator.",
+  "LCRand([seed = 0]): linear congruential generator.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -420,7 +423,7 @@ static PyTypeObject fibrand_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"FibRand([seed = 0]): Fibonacci generator.",
+  "FibRand([seed = 0]): Fibonacci generator.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -565,7 +568,7 @@ static PyTypeObject truerand_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"TrueRand(): true random number source.",
+  "TrueRand(): true random number source.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -775,8 +778,8 @@ static PyObject *gclrmeth_seek(PyObject *me, PyObject *arg)
 
 static PyGetSetDef gccrand_pygetset[] = {
 #define GETSETNAME(op, name) gccr##op##_##name
-  GET  (keysz,                 "CR.keysz -> acceptable key sizes")
-  GET  (name,                  "CR.name -> name of this kind of generator")
+  GET  (keysz,         "CR.keysz -> acceptable key sizes")
+  GET  (name,          "CR.name -> name of this kind of generator")
 #undef GETSETNAME
   { 0 }
 };
@@ -814,7 +817,7 @@ static PyTypeObject gccrand_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Metaclass for symmetric crypto-based generators.",
+  "Metaclass for symmetric crypto-based generators.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -862,7 +865,7 @@ static PyTypeObject gcrand_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Abstract base class for symmetric crypto-based generators.",
+  "Abstract base class for symmetric crypto-based generators.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -910,7 +913,7 @@ static PyTypeObject gclatinrand_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Abstract base class for symmetric crypto-based generators.",
+  "Abstract base class for symmetric crypto-based generators.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -938,7 +941,7 @@ static PyTypeObject gclatinrand_pytype_skel = {
 static PyObject *sslprf_pynew(PyTypeObject *ty, PyObject *arg, PyObject *kw)
 {
   char *k, *s;
-  int ksz, ssz;
+  Py_ssize_t ksz, ssz;
   const gchash *hco = &md5, *hci = &sha;
   PyObject *rc = 0;
   static const char *const kwlist[] = { "key", "seed", "ohash", "ihash", 0 };
@@ -955,7 +958,7 @@ end:
 static PyObject *tlsdx_pynew(PyTypeObject *ty, PyObject *arg, PyObject *kw)
 {
   char *k, *s;
-  int ksz, ssz;
+  Py_ssize_t ksz, ssz;
   const gcmac *mc = &sha_hmac;
   PyObject *rc = 0;
   static const char *const kwlist[] = { "key", "seed", "mac", 0 };
@@ -972,7 +975,7 @@ end:
 static PyObject *tlsprf_pynew(PyTypeObject *ty, PyObject *arg, PyObject *kw)
 {
   char *k, *s;
-  int ksz, ssz;
+  Py_ssize_t ksz, ssz;
   const gcmac *mcl = &md5_hmac, *mcr = &sha_hmac;
   PyObject *rc = 0;
   static const char *const kwlist[] = { "key", "seed", "lmac", "rmac", 0 };
@@ -1011,8 +1014,8 @@ static PyTypeObject sslprf_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"SSLRand(KEY, SEED, [ohash = md5], [ihash = sha]):\n\
-  RNG for SSL master secret.",
+  "SSLRand(KEY, SEED, [ohash = md5], [ihash = sha]):\n"
+  "  RNG for SSL master secret.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1060,8 +1063,8 @@ static PyTypeObject tlsdx_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"TLSDataExpansion(KEY, SEED, [mac = sha_hmac]):\n\
-  TLS data expansion function.",
+  "TLSDataExpansion(KEY, SEED, [mac = sha_hmac]):\n"
+  "  TLS data expansion function.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1109,8 +1112,8 @@ static PyTypeObject tlsprf_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"TLSPRF(KEY, SEED, [lmac = md5_hmac], [rmac = sha_hmac]):\n\
-  TLS pseudorandom function.",
+  "TLSPRF(KEY, SEED, [lmac = md5_hmac], [rmac = sha_hmac]):\n"
+  "  TLS pseudorandom function.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1138,7 +1141,7 @@ static PyTypeObject tlsprf_pytype_skel = {
 static PyObject *dsarand_pynew(PyTypeObject *ty, PyObject *arg, PyObject *kw)
 {
   char *p;
-  int sz;
+  Py_ssize_t sz;
   PyObject *rc = 0;
   static const char *const kwlist[] = { "seed", 0 };
 
@@ -1190,7 +1193,7 @@ static PyTypeObject dsarand_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"DSARand(SEED): pseudorandom number generator for DSA parameters.",
+  "DSARand(SEED): pseudorandom number generator for DSA parameters.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1281,9 +1284,9 @@ static PyObject *bbsget_stepsz(PyObject *me, void *hunoz)
 
 static PyMethodDef bbs_pymethods[] = {
 #define METHNAME(name) bbsmeth_##name
-  METH (step,  "R.step(): steps the generator (not useful)")
-  METH (bits,  "R.bits(N) -> W: returns N bits (<= 32) from the generator")
-  METH (wrap,  "R.wrap(): flushes unused bits in internal buffer")
+  METH (step,          "R.step(): steps the generator (not useful)")
+  METH (bits,   "R.bits(N) -> W: returns N bits (<= 32) from the generator")
+  METH (wrap,          "R.wrap(): flushes unused bits in internal buffer")
 #undef METHNAME
   { 0 }
 };
@@ -1322,7 +1325,7 @@ static PyTypeObject bbs_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"BlumBlumShub(N, [x = 2]): Blum-Blum-Shub pseudorandom number generator.",
+  "BlumBlumShub(N, [x = 2]): Blum-Blum-Shub pseudorandom number generator.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1443,8 +1446,8 @@ static PyObject *bpget_q(PyObject *me, void *hunoz)
 
 static PyMethodDef bbspriv_pymethods[] = {
 #define METHNAME(name) bpmeth_##name
-  METH (ff,                    "R.ff(N): fast-forward N places")
-  METH (rew,                   "R.rew(N): rewind N places")
+  METH (ff,            "R.ff(N): fast-forward N places")
+  METH (rew,           "R.rew(N): rewind N places")
 #undef METHNAME
   { 0 }
 };
@@ -1483,8 +1486,8 @@ static PyTypeObject bbspriv_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"BBSPriv(..., [seed = 2]): Blum-Blum-Shub, with private key.\n\
-  Keywords: n, p, q; must provide at least two",
+  "BBSPriv(..., [seed = 2]): Blum-Blum-Shub, with private key.\n"
+  "  Keywords: n, p, q; must provide at least two",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1511,9 +1514,8 @@ static PyTypeObject bbspriv_pytype_skel = {
 
 static PyMethodDef methods[] = {
 #define METHNAME(name) meth_##name
-  KWMETH(_BBSPriv_generate,            "\
-generate(NBITS, [event = pgen_nullev], [rng = rand],\n\
-        [nsteps = 0], [seed = 2]) -> R")
+  KWMETH(_BBSPriv_generate, "generate(NBITS, [event = pgen_nullev], "
+                             "[rng = rand], [nsteps = 0], [seed = 2]) -> R")
 #undef METHNAME
   { 0 }
 };