aboutsummaryrefslogtreecommitdiffstats
path: root/docs/gettingstarted/developers/binary_api_support.rst
diff options
context:
space:
mode:
authorFlorin Coras <fcoras@cisco.com>2018-12-04 09:21:36 -0800
committerDave Barach <openvpp@barachs.net>2018-12-05 15:36:46 +0000
commit4af830cd7b4a11bb84840183f7eebd6fb43497a6 (patch)
tree3a47abfae6a651a4be8f5c6a6cb180399c90db62 /docs/gettingstarted/developers/binary_api_support.rst
parent01fdbcca130a6575712de99e26f46e21da432d40 (diff)
session/tcp: postpone cleanup on reset
Change-Id: I45fd7538853f84c6c8bf804cc20acbc9601db3ba Signed-off-by: Florin Coras <fcoras@cisco.com>
Diffstat (limited to 'docs/gettingstarted/developers/binary_api_support.rst')
0 files changed, 0 insertions, 0 deletions
2200; background-color: #fff0f0 } /* Literal.String.Delimiter */ .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
#!/usr/bin/env python3
# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Filter for vpe.api to make it Doxygenish.

import re
import sys

if len(sys.argv) < 2:
    sys.stderr.write("Usage: %s <filename>\n" % (sys.argv[0]))
    sys.exit(1)

patterns = [
    # Search for "define" blocks and treat them as structs
    (re.compile(r"^.*(manual_.[^\s]+\s+)?define\s+(?P<name>[^\s]+)"),
     r"typedef struct vl_api_\g<name>_t"),

    # For every "brief" statement at the start of a comment block, add an
    # xref with whatever is on the same line. This gives us an index page
    # with all the API methods in one place.
    # XXX Commented out for now; works but duplicates the brief text in the
    # struct documentation
    # (re.compile(r"/\*\*\s*(?P<b>[\\@]brief)\s+(?P<c>.+)(\*/)$"),
    #  r'/** @xrefitem api "" "VPP API" \g<c> \g<b> \g<c>'),  # capture inline comment close
    # (re.compile(r"/\*\*\s*(?P<b>[\\@]brief)\s+(?P<c>.+)$"),
    #  r'/** @xrefitem api "" "VPP API" \g<c> \g<b> \g<c>'),

    # Since structs don't have params, replace @param with @tparam
    ( re.compile("[\\@]param\\b"), "@tparam"),
]

with open(sys.argv[1]) as fd:
    for line in fd:
        str = line[:-1] # strip \n
        for p in patterns:
            str = p[0].sub(p[1], str)
        sys.stdout.write(str+"\n")