c++ - boost::mpl: 50 を超えるエントリを持つリストの事前生成済みヘッダーファイルを生成する方法は?

Question

50 を超えるエントリを持つリアクションリストを持つステートマシンをコーディングしたいと考えています。

ここで、50 を超えるエントリを持つリストのヘッダーファイルを生成する Python スクリプトをいくつか見つけました。

しかし、単一のヘッダーファイルを生成することはできません。これらのスクリプトの使用方法を説明してもらえますか? また、ブーストのドキュメントにも何の助けも見つかりませんでした。

どんな助けでも大歓迎です。

score 6 · Accepted Answer

重要な更新:

動作するPython環境のみを必要とする、より改良されたスクリプトについては、この質問に対するこの回答で説明されています。

元の回答

Boost メーリングリストで、あなたの質問に対する私の回答を参照してください。

次の bash コードは、51 ～ 100 エントリの MPL コンテナを生成します。他の MPL コンテナータイプを気にせず、単に MPL リストを生成したい場合は、それにCONTAINERS応じての値を調整します。

#! /bin/bash

# The name of this script.
SCRIPT_NAME=$(basename $0)
# The usage message for this script.
USAGE="Usage:  ${SCRIPT_NAME} <path-to-boost-source> [<new-value-for BOOST_MPL_LIMIT_VECTOR_SIZE>]"

# Script-arguments:
# The (absolute) path to the directory containing the Boost-source.
SOURCE=$(readlink -e "$1")
# The new limit for Boost.MPL's vector.
NEW_BOOST_MPL_LIMIT_VECTOR_SIZE=$2

# Check validity of arguments.
if [[ -z "${SOURCE}" ]] || ! [[ -d "${SOURCE}" ]]; then
  echo "Missing path to Boost directory."
  echo ${USAGE}
  exit
fi
REGEX_INTEGER='^[0-9]+$'
if [[ -n "${NEW_BOOST_MPL_LIMIT_VECTOR_SIZE}" ]] && ! [[ ${NEW_BOOST_MPL_LIMIT_VECTOR_SIZE} =~ ${REGEX_INTEGER} ]]; then
  echo "New size for BOOST_MPL_LIMIT_VECTOR_SIZE must be an unsigned integer!"
  echo ${USAGE}
  exit
fi


# The Boost.MPL-containers for which more preprocessed
# header-files shall be generated.
CONTAINERS="vector list set map"
# The same containers without Boost.MPL-map.
CONTAINERS_WITHOUT_MAP=$(echo ${CONTAINERS} | sed 's/map//g')

# Change into include-directory of Boost.MPL.
pushd ${SOURCE}/boost/mpl  >/dev/null 2>&1

# Possibly change the limit for Boost.MPL's vector.
if [[ -n "${NEW_BOOST_MPL_LIMIT_VECTOR_SIZE}" ]]; then
  sed -i "s/\(define\s\+BOOST_MPL_LIMIT_VECTOR_SIZE\s\+\)[0-9]\+/\1${NEW_BOOST_MPL_LIMIT_VECTOR_SIZE}/" ./limits/vector.hpp
fi

# Create hpp-files for each MPL-container with 60 to 100 elements
# which will be used during generation.
for container in ${CONTAINERS}; do
  for i in {6..10}; do
    sed -e "s/50/${i}0/g" \
        -e "s/41/$((i-1))1/g" \
        -e "s/40/$((i-1))0/g" \
        ./${container}/${container}50.hpp \
      > ./${container}/${container}${i}0.hpp;
  done
done
for container in ${CONTAINERS_WITHOUT_MAP}; do
  for i in {6..10}; do
    sed -e "s/50/${i}0/g" \
        -e "s/41/$((i-1))1/g" \
        -e "s/40/$((i-1))0/g" \
        ./${container}/${container}50_c.hpp \
      > ./${container}/${container}${i}0_c.hpp;
  done
done

# Leave include-directory of Boost.MPL.
popd  >/dev/null 2>&1
# Change into source-directory of Boost.MPL.
pushd ${SOURCE}/libs/mpl/preprocessed  >/dev/null 2>&1

# Create cpp-files for each MPL-container with 60 to 100 elements
# which will be used during generation.
for container in ${CONTAINERS}; do
  for i in {6..10}; do
    sed -e "s/50/${i}0/g" \
        -e "s/41/$((i-1))1/g" \
        -e "s/40/$((i-1))0/g" \
        ./${container}/${container}50.cpp \
      > ./${container}/${container}${i}0.cpp;
  done
done
for container in ${CONTAINERS_WITHOUT_MAP}; do
  for i in {6..10}; do
    sed -e "s/50/${i}0/g" \
        -e "s/41/$((i-1))1/g" \
        -e "s/40/$((i-1))0/g" \
        ./${container}/${container}50_c.cpp \
      > ./${container}/${container}${i}0_c.cpp;
  done
done

# Now generate MPL-preprocessed files using the python-scripts.
python preprocess_vector.py all ${SOURCE}
python preprocess_list.py   all ${SOURCE}
python preprocess_set.py    all ${SOURCE}
python preprocess_map.py    all ${SOURCE}
python preprocess.py        all ${SOURCE}

# Leave source-directory of Boost.MPL.
popd  >/dev/null 2>&1

100 を超えるエントリがあるさらに大きなコンテナーの場合は、for ループの範囲を調整します。

それが役立つことを願っています。
デニズ

アップデート：

スクリプトの元のバージョンでは、MPL コンテナーヘッダーの番号付きバージョンしか生成されないことに気付きました。ただし、番号のないバージョンは更新されませんでした。

python preprocess.py all ${SOURCE}スクリプトの最後近くに追加して修正しました。ただし、これは、生成中に対応するマクロ設定 (例: のより高い値BOOST_MPL_LIMIT_VECTOR_SIZE) が元の値と異なる場合、番号のない MPL コンテナーヘッダーの変更されたバージョンのみを生成します。

user.hppこれらの変更は、の各サブディレクトリ内のファイルで行うことができます${SOURCE}/libs/mpl/preprocessed/include。

たとえば、

#define BOOST_MPL_LIMIT_VECTOR_SIZE 30

to (に含まれる from ) は、デフォルトの 20 の代わりに、30 の要素を保持できるようになりました${SOURCE}/libs/mpl/preprocessed/include/gcc/user.hpp。boost::mpl::vectorboost/mpl/vector.hpp

ノート：

BOOST_MPL_LIMIT_VECTOR_SIZEただし、生成のみのように値を調整し、その値をそのままにしておくのは得策ではないかもしれません${SOURCE}/boost/mpl/limits/vector.hpp。
おそらく、基になるboost::mpl::vector21toboost::mpl::vectorNが見つからないため (自動的に含まれないため)、これはコンパイルさえできません。最適な解決策は、おそらくの値を調整することです${SOURCE}/boost/mpl/limits/vector.hpp。上記の bash-script は、2 番目の (オプションの) 引数が指定されている場合、自動的に実行できます。

score 5 · Accepted Answer

最終更新

Boost 1.59.0から、以下で説明するスクリプトが各 Boost リリースに含まれるようになりました。

それらは int <boost-source-dir>/libs/mpl/preprocessed/にあります。

そのディレクトリにあるREADME.txtに、その使用方法が説明されています。（または、読み進めてください。）

元の答え

誰もが有効なbashシェルを手元に持っているわけではないことに気付いたので(そうです、Windows の皆さん ;-))、誰もが有効なpython環境を必要としていることに気付いたので、上記のヘルパー bash スクリプトをpython に変換しました。

boost_mpl_preprocess.py

# Copyright Deniz Bahadir 2015
#
# Distributed under the Boost Software License, Version 1.0. 
# (See accompanying file LICENSE_1_0.txt or copy at 
# http://www.boost.org/LICENSE_1_0.txt)
#
# See http://www.boost.org/libs/mpl for documentation.
# See https://stackoverflow.com/a/20660264/3115457 for further information.
# See https://stackoverflow.com/a/29627158/3115457 for further information.

import argparse
import sys
import os
import os.path
import re
import fileinput
import shutil


def create_more_container_files(sourceDir, suffix, maxElements, containers, containers2):
    """Creates additional files for the individual MPL-containers."""

    # Create files for each MPL-container with 20 to 'maxElements' elements
    # which will be used during generation.
    for container in containers:
        for i in range(20, maxElements, 10):
            # Create copy of "template"-file.
            newFile = os.path.join( sourceDir, container, container + str(i+10) + suffix )
            shutil.copyfile( os.path.join( sourceDir, container, container + "20" + suffix ), newFile ) 
            # Adjust copy of "template"-file accordingly.
            for line in fileinput.input( newFile, inplace=1, mode="rU" ):
                line = re.sub(r'20', re.escape(str(i+10)), line.rstrip())
                line = re.sub(r'11', re.escape(str(i + 1)), line.rstrip())
                line = re.sub(r'10(?![0-9])', re.escape(str(i)), line.rstrip())
                print(line)
    for container in containers2:
        for i in range(20, maxElements, 10):
            # Create copy of "template"-file.
            newFile = os.path.join( sourceDir, container, container + str(i+10) + "_c" + suffix )
            shutil.copyfile( os.path.join( sourceDir, container, container + "20_c" + suffix ), newFile ) 
            # Adjust copy of "template"-file accordingly.
            for line in fileinput.input( newFile, inplace=1, mode="rU" ):
                line = re.sub(r'20', re.escape(str(i+10)), line.rstrip())
                line = re.sub(r'11', re.escape(str(i + 1)), line.rstrip())
                line = re.sub(r'10(?![0-9])', re.escape(str(i)), line.rstrip())
                print(line)


def create_input_for_numbered_sequences(headerDir, sourceDir, containers, maxElements):
    """Creates additional source- and header-files for the numbered sequence MPL-containers."""
    # Create additional container-list without "map".
    containersWithoutMap = containers[:]
    try:
        containersWithoutMap.remove('map')
    except ValueError:
        # We can safely ignore if "map" is not contained in 'containers'!
        pass
    # Create header/source-files.
    create_more_container_files(headerDir, ".hpp", maxElements, containers, containersWithoutMap)
    create_more_container_files(sourceDir, ".cpp", maxElements, containers, containersWithoutMap)


def adjust_container_limits_for_variadic_sequences(headerDir, containers, maxElements):
    """Adjusts the limits of variadic sequence MPL-containers."""
    for container in containers:
        headerFile = os.path.join( headerDir, "limits", container + ".hpp" )
        regexMatch   = r'(define\s+BOOST_MPL_LIMIT_' + container.upper() + r'_SIZE\s+)[0-9]+'
        regexReplace = r'\g<1>' + re.escape( str(maxElements) )
        for line in fileinput.input( headerFile, inplace=1, mode="rU" ):
            line = re.sub(regexMatch, regexReplace, line.rstrip())
            print(line)


def to_positive_multiple_of_10(string):
    """Converts a string into its encoded positive integer (greater zero) or throws an exception."""
    try:
        value = int(string)
    except ValueError:
        msg = '"%r" is not a positive multiple of 10 (greater zero).' % string
        raise argparse.ArgumentTypeError(msg)
    if value <= 0 or value % 10 != 0:
        msg = '"%r" is not a positive multiple of 10 (greater zero).' % string
        raise argparse.ArgumentTypeError(msg)
    return value


def to_existing_absolute_path(string):
    """Converts a path into its absolute path and verifies that it exists or throws an exception."""
    value = os.path.abspath(string)
    if not os.path.exists( value ) or not os.path.isdir( value ):
        msg = '"%r" is not a valid path to a directory.' % string
        raise argparse.ArgumentTypeError(msg)
    return value


def main():
    """The main function."""

    # Prepare and run cmdline-parser.
    cmdlineParser = argparse.ArgumentParser(description="A generator-script for pre-processed Boost.MPL headers.")
    cmdlineParser.add_argument("-v", "--verbose", dest='verbose', action='store_true',
                               help="Be a little bit more verbose.")
    cmdlineParser.add_argument("-s", "--sequence-type", dest='seqType', choices=['variadic', 'numbered', 'both'],
                               default='both',
                               help="Only update pre-processed headers for the selected sequence types, "
                                    "either 'numbered' sequences, 'variadic' sequences or 'both' sequence "
                                    "types. (Default=both)")
    cmdlineParser.add_argument("--no-vector", dest='want_vector', action='store_false',
                               help="Do not update pre-processed headers for Boost.MPL Vector.")
    cmdlineParser.add_argument("--no-list", dest='want_list', action='store_false',
                               help="Do not update pre-processed headers for Boost.MPL List.")
    cmdlineParser.add_argument("--no-set", dest='want_set', action='store_false',
                               help="Do not update pre-processed headers for Boost.MPL Set.")
    cmdlineParser.add_argument("--no-map", dest='want_map', action='store_false',
                               help="Do not update pre-processed headers for Boost.MPL Map.")
    cmdlineParser.add_argument("--num-elements", dest='numElements', metavar="<num-elements>",
                               type=to_positive_multiple_of_10, default=100,
                               help="The maximal number of elements per container sequence. (Default=100)")
    cmdlineParser.add_argument(dest='sourceDir', metavar="<source-dir>",
                               type=to_existing_absolute_path,
                               help="The source-directory of Boost.")
    args = cmdlineParser.parse_args()

    # Some verbose debug output.
    if args.verbose:
        print "Arguments extracted from command-line:"
        print "  verbose          = ", args.verbose
        print "  source directory = ", args.sourceDir
        print "  num elements     = ", args.numElements
        print "  sequence type    = ", args.seqType
        print "  want: vector     = ", args.want_vector
        print "  want: list       = ", args.want_list
        print "  want: set        = ", args.want_set
        print "  want: map        = ", args.want_map

    # The directories for header- and source files of Boost.MPL.    
    # NOTE: Assuming 'args.sourceDir' is the source-directory of the entire boost project.
    headerDir = os.path.join( args.sourceDir, "boost", "mpl" )
    sourceDir = os.path.join( args.sourceDir, "libs", "mpl", "preprocessed" )
    # Check that the header/source-directories exist.
    if not os.path.exists( headerDir ) or not os.path.exists( sourceDir ):
        # Maybe 'args.sourceDir' is not the source-directory of the entire boost project
        # but instead of the Boost.MPL git-directory, only?
        headerDir = os.path.join( args.sourceDir, "include", "boost", "mpl" )
        sourceDir = os.path.join( args.sourceDir, "preprocessed" )
        if not os.path.exists( headerDir ) or not os.path.exists( sourceDir ):
            cmdlineParser.print_usage()
            print "error: Cannot find Boost.MPL header/source files in given Boost source-directory!"
            sys.exit(0)

    # Some verbose debug output.
    if args.verbose:
        print "Chosen header-directory: ", headerDir
        print "Chosen source-directory: ", sourceDir

    # Create list of containers for which files shall be pre-processed.
    containers = []
    if args.want_vector:
        containers.append('vector')
    if args.want_list:
        containers.append('list')
    if args.want_set:
        containers.append('set')
    if args.want_map:
        containers.append('map')
    if containers == []:
        print "Nothing to do. (Why did you prevent generating pre-processed headers for all Boost.MPL container types?"
        sys.exit(0)

    # Some verbose debug output.
    if args.verbose:
        print "Containers for which to pre-process headers: ", containers

    # Create (additional) input files for generating pre-processed headers of numbered sequence MPL containers.
    if args.seqType == "both" or args.seqType == "numbered":
        create_input_for_numbered_sequences(headerDir, sourceDir, containers, args.numElements)
    # Modify settings for generating pre-processed headers of variadic sequence MPL containers.
    if args.seqType == "both" or args.seqType == "variadic":
        adjust_container_limits_for_variadic_sequences(headerDir, containers, args.numElements)

    # Generate MPL-preprocessed files.
    os.chdir( sourceDir )
    if args.seqType == "both" or args.seqType == "numbered":
        if args.want_vector:
            if args.verbose:
                print "Pre-process headers for Boost.MPL numbered vectors."
            os.system( "python " + os.path.join( sourceDir, "preprocess_vector.py" ) + " all " + args.sourceDir )
        if args.want_list:
            if args.verbose:
                print "Pre-process headers for Boost.MPL numbered lists."
            os.system( "python " + os.path.join( sourceDir, "preprocess_list.py" ) + " all " + args.sourceDir )
        if args.want_set:
            if args.verbose:
                print "Pre-process headers for Boost.MPL numbered sets."
            os.system( "python " + os.path.join( sourceDir, "preprocess_set.py" ) + " all " + args.sourceDir )
        if args.want_map:
            if args.verbose:
                print "Pre-process headers for Boost.MPL numbered maps."
            os.system( "python " + os.path.join( sourceDir, "preprocess_map.py" ) + " all " + args.sourceDir )
    if args.seqType == "both" or args.seqType == "variadic":
        if args.verbose:
            print "Pre-process headers for Boost.MPL variadic containers."
        os.system( "python " + os.path.join( sourceDir, "preprocess.py" ) + " all " + args.sourceDir )


if __name__ == '__main__':
    main()

で実行する

python boost_mpl_preprocess.py --help

いくつかの使用情報を提供します。

ただし、Boost ソースディレクトリへのパスを決定する単一のコマンドラインパラメータ (例: python boost_mpl_preprocess.py ./boost-source) を指定して実行し、デフォルトの動作を使用することもできます。

これにより、4 つのすべての Boost.MPL コンテナータイプ ( vector、list、setおよびmap) の前処理済みヘッダーが、番号付きおよび可変長形式で作成されます。

ノート：

Boost.MPLコンテナーを可変長形式で前処理する際の副作用として、関連する limit-macros の値BOOST_MPL_LIMIT_container_SIZEも変更されます。boost_mpl_preprocess.pyを呼び出したときに決定された要素の数を取得します。

たとえば、次の呼び出しは、Boost.MPL の可変長形式のみを前処理し、マクロvectorをに設定BOOST_MPL_LIMIT_VECTOR_SIZEし./boost-source/boost/mpl/limits/vector.hppます70。

$ python boost_mpl_preprocess.py --no-list --no-set --no-map \
    --sequence-type=variadic --num-elements=70 ./boost-source

アップデート

Boost 1.56 では、上記のスクリプトを使用しても Boost.MPL コンテナーの前処理が機能しなくなったため、ヘッダーコメントが変更されたため、元の python-scripts に依存していました。

次のスクリプトを使用して、この問題を解決できます。不足している情報をヘッダーコメントに追加するだけです。

fix_boost_mpl_preprocess.py

# Copyright Deniz Bahadir 2015
#
# Distributed under the Boost Software License, Version 1.0. 
# (See accompanying file LICENSE_1_0.txt or copy at 
# http://www.boost.org/LICENSE_1_0.txt)
#
# See http://www.boost.org/libs/mpl for documentation.
# See https://stackoverflow.com/a/29627158/3115457 for further information.

import argparse
import sys
import os.path
import re
import fileinput
import datetime
import glob


def fix_header_comment(filename, timestamp):
    """Fixes the header-comment of the given file."""
    # Fix input file.
    name = os.path.basename( filename )
    for line in fileinput.input( filename, inplace=1, mode="rU" ):
        # If header-comment already contains anything for '$Id$', remove it.
        line = re.sub(r'\$Id:[^$]+\$', r'$Id$', line.rstrip())
        # Replace '$Id$' by a string containing the file's name (and a timestamp)!
        line = re.sub(re.escape(r'$Id$'), r'$Id: ' + name + r' ' + timestamp.isoformat() + r' $', line.rstrip())
        print(line)


def fix_input_files_for_variadic_seq(sourceDir, timestamp):
    """Fixes files used as input when pre-processing MPL-containers in their variadic form."""
    files = glob.glob( os.path.join( sourceDir, "src", "*" ) )
    for currentFile in sorted( files ):
        fix_header_comment( currentFile, timestamp )


def fix_input_files_for_numbered_seq(sourceDir, suffix, timestamp, containers):
    """Fixes files used as input when pre-processing MPL-containers in their numbered form."""
    # Fix input files for each MPL-container type.
    for container in containers:
        files = glob.glob( os.path.join( sourceDir, container, container + '*' + suffix ) )
        for currentFile in sorted( files ):
            fix_header_comment( currentFile, timestamp )


def fix_input_files(headerDir, sourceDir, containers=['vector', 'list', 'set', 'map'], verbose='false'):
    """Fixes source- and header-files used as input when pre-processing MPL-containers."""
    # The new modification time.
    timestamp = datetime.datetime.now();
    # Fix the input files.
    if verbose:
        print "Fix input files for pre-processing Boost.MPL variadic containers."
    fix_input_files_for_variadic_seq(sourceDir, timestamp)
    if verbose:
        print "Fix input files for pre-processing Boost.MPL numbered containers."
    fix_input_files_for_numbered_seq(headerDir, ".hpp", timestamp, containers)
    fix_input_files_for_numbered_seq(sourceDir, ".cpp", timestamp, containers)


def to_existing_absolute_path(string):
    """Converts a path into its absolute path and verifies that it exists or throws an exception."""
    value = os.path.abspath(string)
    if not os.path.exists( value ) or not os.path.isdir( value ):
        msg = '"%r" is not a valid path to a directory.' % string
        raise argparse.ArgumentTypeError(msg)
    return value


def main():
    """The main function."""

    # Prepare and run cmdline-parser.
    cmdlineParser = argparse.ArgumentParser(
                    description="Fixes the input files used for pre-processing of Boost.MPL headers.")
    cmdlineParser.add_argument("-v", "--verbose", dest='verbose', action='store_true',
                               help="Be a little bit more verbose.")
    cmdlineParser.add_argument(dest='sourceDir', metavar="<source-dir>",
                               type=to_existing_absolute_path,
                               help="The source-directory of Boost.")
    args = cmdlineParser.parse_args()

    # Some verbose debug output.
    if args.verbose:
        print "Arguments extracted from command-line:"
        print "  verbose           = ", args.verbose
        print "  source directory  = ", args.sourceDir

    # The directories for header- and source files of Boost.MPL.    
    # NOTE: Assuming 'args.sourceDir' is the source-directory of the entire boost project.
    headerDir = os.path.join( args.sourceDir, "boost", "mpl" )
    sourceDir = os.path.join( args.sourceDir, "libs", "mpl", "preprocessed" )
    # Check that the header/source-directories exist.
    if not os.path.exists( headerDir ) or not os.path.exists( sourceDir ):
        # Maybe 'args.sourceDir' is not the source-directory of the entire boost project
        # but instead of the Boost.MPL git-directory, only?
        headerDir = os.path.join( args.sourceDir, "include", "boost", "mpl" )
        sourceDir = os.path.join( args.sourceDir, "preprocessed" )
        if not os.path.exists( headerDir ) or not os.path.exists( sourceDir ):
            cmdlineParser.print_usage()
            print "error: Cannot find Boost.MPL header/source files in given Boost source-directory!"
            sys.exit(0)

    # Some verbose debug output.
    if args.verbose:
        print "Chosen header-directory: ", headerDir
        print "Chosen source-directory: ", sourceDir

    # Fix input file for generating pre-processed headers.
    fix_input_files(headerDir, sourceDir, verbose = args.verbose)


if __name__ == '__main__':
    main()

次のように実行します。

$ python fix-boost_mpl_preprocess.py ./boost-source

c++ - boost::mpl: 50 を超えるエントリを持つリストの事前生成済みヘッダー ファイルを生成する方法は?

3 に答える 3

最終更新

元の答え

アップデート

Related

Reference

c++ - boost::mpl: 50 を超えるエントリを持つリストの事前生成済みヘッダーファイルを生成する方法は?