*.c: Reformat docstrings.

[catacomb-python] / ec.c

diff --git a/ec.c b/ec.c
index 6280010..9c94bee 100644 (file)
--- a/ec.c
+++ b/ec.c
@@ -48,13 +48,13 @@ ec_curve *eccurve_copy(ec_curve *c)
     return (0);
   a = F_OUT(f, MP_NEW, c->a);
   b = F_OUT(f, MP_NEW, c->b);
-  if (strcmp(EC_NAME(c), "prime") == 0)
+  if (STRCMP(EC_NAME(c), ==, "prime"))
     c = ec_prime(f, a, b);
-  else if (strcmp(EC_NAME(c), "primeproj") == 0)
+  else if (STRCMP(EC_NAME(c), ==, "primeproj"))
     c = ec_primeproj(f, a, b);
-  else if (strcmp(EC_NAME(c), "bin") == 0)
+  else if (STRCMP(EC_NAME(c), ==, "bin"))
     c = ec_bin(f, a, b);
-  else if (strcmp(EC_NAME(c), "binproj") == 0)
+  else if (STRCMP(EC_NAME(c), ==, "binproj"))
     c = ec_binproj(f, a, b);
   else
     c = 0;
@@ -292,9 +292,9 @@ static PyObject *epmeth_ec2osp(PyObject *me, PyObject *arg, PyObject *kw)
   ec pp = EC_INIT;
   unsigned f = EC_EXPLY;
   int len;
-  char *kwlist[] = { "flags", 0 };
+  static const char *const kwlist[] = { "flags", 0 };
 
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "|O&:ec2osp", kwlist,
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "|O&:ec2osp", KWLIST,
                                   convuint, &f))
     return (0);
   len = c->f->noctets * 2 + 1;
@@ -473,6 +473,7 @@ static int ecptxl_1(ec_curve *c, ec *p, PyObject *x)
        (n == 3 && (z = PySequence_GetItem(t, 2)) == 0))
       goto end;
     rc = (n == 2) ? ecptxl_2(c, p, x, y) : ecptxl_3(c, p, x, y, z);
+    goto end;
   } else
     TYERR("can't convert to curve point");
   goto ok;
@@ -501,14 +502,14 @@ static PyObject *ecptnc_pynew(PyTypeObject *ty, PyObject *arg, PyObject *kw)
 {
   PyObject *x = 0, *y = 0, *z = 0;
   ec p = EC_INIT;
-  char *kwlist[] = { "x", "y", 0 };
+  static const char *const kwlist[] = { "x", "y", 0 };
 
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "|OO:new", kwlist, &x, &y) ||
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "|OO:new", KWLIST, &x, &y) ||
       ecptxl(0, &p, x, y, z))
     goto end;
   return (ecpt_pywrapout(ty, &p));
 end:
-  EC_DESTROY(&p);
+  mp_drop(p.x); mp_drop(p.y); mp_drop(p.z);
   return (0);
 }
 
@@ -542,15 +543,15 @@ static PyObject *ecpt_pynew(PyTypeObject *ty, PyObject *arg, PyObject *kw)
 {
   PyObject *x = 0, *y = 0, *z = 0;
   ec p = EC_INIT;
-  char *kwlist[] = { "x", "y", "z", 0 };
+  static const char *const kwlist[] = { "x", "y", "z", 0 };
 
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "|OOO:new", kwlist,
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "|OOO:new", KWLIST,
                                   &x, &y, &z) ||
       ecptxl(ECCURVE_C(ty), &p, x, y, z))
     goto end;
   return (ecpt_pywrap((PyObject *)ty, &p));
 end:
-  EC_DESTROY(&p);
+  mp_drop(p.x); mp_drop(p.y); mp_drop(p.z);
   return (0);
 }
 
@@ -639,7 +640,9 @@ static PyTypeObject ecpt_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Elliptic curve points, not associated with any curve.",
+  "ECPt([X, [Y]]): elliptic curve points, not associated with any curve.\n"
+  "  X alone may be None, an existing point, a string 'X, Y', an\n"
+  "  x-coordinate, or a pair (X, Y); X and Y should be a coordinate pair.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -754,7 +757,7 @@ static PyTypeObject ecptcurve_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Elliptic curve points; abstract base class for points on given curves.",
+  "Elliptic curve points; abstract base class for points on given curves.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -861,9 +864,9 @@ static PyObject *meth__ECPtCurve_os2ecp(PyObject *me,
   ec_curve *cc;
   unsigned f = EC_XONLY | EC_LSB | EC_SORT | EC_EXPLY;
   ec pp = EC_INIT;
-  char *kwlist[] = { "class", "buf", "flags", 0 };
+  static const char *const kwlist[] = { "class", "buf", "flags", 0 };
 
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "Os#|O&:os2ecp", kwlist,
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "Os#|O&:os2ecp", KWLIST,
                                   &me, &p, &len, convuint, &f))
     return (0);
   buf_init(&b, p, len);
@@ -939,11 +942,11 @@ end:
 
 static PyObject *ecmeth_rand(PyObject *me, PyObject *arg, PyObject *kw)
 {
-  char *kwlist[] = { "rng", 0 };
+  static const char *const kwlist[] = { "rng", 0 };
   grand *r = &rand_global;
   ec p = EC_INIT;
 
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "|O&:rand", kwlist,
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "|O&:rand", KWLIST,
                                   convgrand, &r))
     return (0);
   ec_rand(ECCURVE_C(me), &p, r);
@@ -980,13 +983,13 @@ PyObject *eccurve_pywrap(PyObject *fobj, ec_curve *c)
   else
     Py_INCREF(fobj);
   assert(FIELD_F(fobj) == c->f);
-  if (strcmp(EC_NAME(c), "prime") == 0)
+  if (STRCMP(EC_NAME(c), ==, "prime"))
     ty = ecprimecurve_pytype;
-  else if (strcmp(EC_NAME(c), "primeproj") == 0)
+  else if (STRCMP(EC_NAME(c), ==, "primeproj"))
     ty = ecprimeprojcurve_pytype;
-  else if (strcmp(EC_NAME(c), "bin") == 0)
+  else if (STRCMP(EC_NAME(c), ==, "bin"))
     ty = ecbincurve_pytype;
-  else if (strcmp(EC_NAME(c), "binproj") == 0)
+  else if (STRCMP(EC_NAME(c), ==, "binproj"))
     ty = ecbinprojcurve_pytype;
   else
     abort();
@@ -999,10 +1002,10 @@ static PyObject *eccurve_pynew(PyTypeObject *ty,
 {
   PyObject *fobj;
   PyObject *cobj = 0;
-  char *kwlist[] = { "field", "a", "b", 0 };
+  static const char *const kwlist[] = { "field", "a", "b", 0 };
   mp *aa = 0, *bb = 0;
 
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "O!O&O&", kwlist,
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "O!O&O&", KWLIST,
                                   field_pytype, &fobj,
                                   convmp, &aa, convmp, &bb))
     goto end;
@@ -1060,8 +1063,7 @@ static PyGetSetDef eccurve_pygetset[] = {
 
 static PyMethodDef eccurve_pymethods[] = {
 #define METHNAME(name) ecmeth_##name
-  METH (mmul,          "\
-E.mmul([(P0, N0), (P1, N1), ...]) = N0 P0 + N1 P1 + ...")
+  METH (mmul,     "E.mmul([(P0, N0), (P1, N1), ...]) = N0 P0 + N1 P1 + ...")
   METH (find,          "E.find(X) -> P")
   KWMETH(rand,         "E.rand([rng = rand]) -> P")
 #undef METHNAME
@@ -1147,7 +1149,8 @@ static PyTypeObject ecprimecurve_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-  "An elliptic curve over a prime field.  Use ecprimeprojcurve.",
+  "ECPrimeCurve(FIELD, A, B): an elliptic curve over a prime field.\n"
+  "  Use ECPrimeProjCurve instead.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1201,7 +1204,8 @@ static PyTypeObject ecprimeprojcurve_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-  "An elliptic curve over a prime field, using projective coordinates.",
+  "ECPrimeProjCurve(FIELD, A, B): an elliptic curve over a prime field\n"
+  "  using projective coordinates.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1255,7 +1259,8 @@ static PyTypeObject ecbincurve_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-  "An elliptic curve over a binary field.  Use ecbinprojcurve.",
+  "ECBinCurve(FIELD, A, B): an elliptic curve over a binary field.\n"
+  "  Use ECBinProjCurve instead.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1309,7 +1314,8 @@ static PyTypeObject ecbinprojcurve_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-  "An elliptic curve over a binary field, using projective coordinates.",
+  "ECBinProjCurve(FIELD, A, B): an elliptic curve over a binary field,\n"
+  "  using projective coordinates.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1370,10 +1376,10 @@ static PyObject *ecinfo_pynew(PyTypeObject *ty, PyObject *arg, PyObject *kw)
 {
   ec_info ei = { 0 };
   PyObject *e, *g;
-  char *kwlist[] = { "curve", "G", "r", "h", 0 };
+  static const char *const kwlist[] = { "curve", "G", "r", "h", 0 };
   ecinfo_pyobj *rc = 0;
 
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "O!O!O&O&:new", kwlist,
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "O!O!O&O&:new", KWLIST,
                                   eccurve_pytype, &e, ecpt_pytype, &g,
                                   convmp, &ei.r, convmp, &ei.h))
     goto end;
@@ -1441,11 +1447,11 @@ end:
 
 static PyObject *eimeth_check(PyObject *me, PyObject *arg, PyObject *kw)
 {
-  char *kwlist[] = { "rng", 0 };
+  static const char *const kwlist[] = { "rng", 0 };
   grand *r = &rand_global;
   const char *p;
 
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "|O&:check", kwlist,
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "|O&:check", KWLIST,
                                   convgrand, &r))
     goto end;
   if ((p = ec_checkinfo(ECINFO_EI(me), r)) != 0)
@@ -1514,7 +1520,7 @@ static PyTypeObject ecinfo_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-  "Elliptic curve domain parameters.",
+  "ECInfo(CURVE, G, R, H): elliptic curve domain parameters.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1541,13 +1547,13 @@ static PyTypeObject ecinfo_pytype_skel = {
 
 static PyMethodDef methods[] = {
 #define METHNAME(func) meth_##func
-  METH (_ECPt_frombuf,         "frombuf(E, STR) -> (P, REST)")
-  METH (_ECPtCurve_fromraw,    "fromraw(E, STR) -> (P, REST)")
-  KWMETH(_ECPtCurve_os2ecp,    "os2ecp(E, STR, [flags = ...]) -> (P, REST)")
-  METH (_ECPt_parse,           "parse(E, STR) -> (P, REST)")
-  METH (_ECCurve_parse,        "parse(STR) -> (E, REST)")
-  METH (_ECInfo_parse,         "parse(STR) -> (I, REST)")
-  METH (_ECInfo__curven,       "_curven(N) -> I")
+  METH (_ECPt_frombuf, "frombuf(E, STR) -> (P, REST)")
+  METH (_ECPtCurve_fromraw, "fromraw(E, STR) -> (P, REST)")
+  KWMETH(_ECPtCurve_os2ecp, "os2ecp(E, STR, [flags = ...]) -> (P, REST)")
+  METH (_ECPt_parse,   "parse(E, STR) -> (P, REST)")
+  METH (_ECCurve_parse, "parse(STR) -> (E, REST)")
+  METH (_ECInfo_parse, "parse(STR) -> (I, REST)")
+  METH (_ECInfo__curven, "_curven(N) -> I")
 #undef METHNAME
   { 0 }
 };