1# -*- coding: utf-8 -*-
2# Copyright (c) 2015 Jason Power
3# All rights reserved.
4#
5# Redistribution and use in source and binary forms, with or without
6# modification, are permitted provided that the following conditions are
7# met: redistributions of source code must retain the above copyright
8# notice, this list of conditions and the following disclaimer;
9# redistributions in binary form must reproduce the above copyright
10# notice, this list of conditions and the following disclaimer in the
11# documentation and/or other materials provided with the distribution;
12# neither the name of the copyright holders nor the names of its
13# contributors may be used to endorse or promote products derived from
14# this software without specific prior written permission.
15#
16# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27#
28# Authors: Jason Power
29
30from __future__ import print_function
31from __future__ import absolute_import
32
33""" Options wrapper for simple gem5 configuration scripts
34
35This module wraps the optparse class so that we can register options
36from each class instead of only from the configuration script.
37
38"""
39
40# Module-level variable to track if we've called the parse_args function yet
41called_parse_args = False
42
43# For fatal
44import m5
45
46# import the options parser
47from optparse import OptionParser
48
49# add the options we want to be able to control from the command line
50parser = OptionParser()
51
52def add_option(*args, **kwargs):
53    """Call "add_option" to the global options parser
54    """
55
56    if (parser.has_option(args[0]) or
57            (len(args) > 1 and parser.has_option(args[1])) ):
58        m5.fatal("Duplicate option: %s" % str(args))
59
60    if called_parse_args:
61        m5.fatal("Can't add an option after calling SimpleOpts.parse_args")
62
63    parser.add_option(*args, **kwargs)
64
65def parse_args():
66    global called_parse_args
67    called_parse_args = True
68
69    return parser.parse_args()
70
71def set_usage(*args, **kwargs):
72    parser.set_usage(*args, **kwargs)
73
74def print_help(*args, **kwargs):
75    parser.print_help(*args, **kwargs)
76
77