111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#!/usr/bin/env python3
211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#
311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert# Copyright (c) 2015-2016 The Khronos Group Inc.
411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert# Copyright (c) 2015-2016 Valve Corporation
511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert# Copyright (c) 2015-2016 LunarG, Inc.
611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert# Copyright (c) 2015-2016 Google Inc.
711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#
811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert# Licensed under the Apache License, Version 2.0 (the "License");
911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert# you may not use this file except in compliance with the License.
1011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert# You may obtain a copy of the License at
1111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#
1211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#     http://www.apache.org/licenses/LICENSE-2.0
1311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#
1411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert# Unless required by applicable law or agreed to in writing, software
1511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert# distributed under the License is distributed on an "AS IS" BASIS,
1611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert# See the License for the specific language governing permissions and
1811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert# limitations under the License.
1911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#
2011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert# Author: Tobin Ehlis <tobin@lunarg.com>
2111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert
2211cd02dfb91661c65134cac258cf5924270e9d2Dan Albertfrom inspect import currentframe, getframeinfo
2311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert
2411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert# This is a wrapper class for inspect module that returns a formatted line
2511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#  with details of the source file and line number of python code who called
2611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#  into this class. The result can them be added to codegen to simplify
2711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#  debug as it shows where code was generated from.
2811cd02dfb91661c65134cac258cf5924270e9d2Dan Albertclass sourcelineinfo():
2911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert    def __init__(self):
3011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert        self.general_prefix = "// CODEGEN : "
3111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert        self.file_prefix = "file "
3211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert        self.line_prefix = "line #"
3311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert        self.enabled = True
3411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert
3511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert    def get(self):
3611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert        if self.enabled:
3711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert            frameinfo = getframeinfo(currentframe().f_back)
3811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert            return "%s%s%s %s%s" % (self.general_prefix, self.file_prefix, frameinfo.filename, self.line_prefix, frameinfo.lineno)
3911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert        return ""
40