#!/usr/bin/python3

# Copyright © 2012, 2013 Jakub Wilk <jwilk@debian.org>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the “Software”), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

import os
import re
import sys

import apt_pkg

tag_re = re.compile(r"^:\s+Tags[(]qw[(](.+?)[)][)]")

required_fields = {'Tag', 'Description'}
known_fields = required_fields | {'References'}

def main():
    base = os.path.join(os.path.dirname(__file__), os.pardir)
    desc_fn = os.path.join(base, 'doc', 'tags.desc')
    code_fn = os.path.join(base, 'adequate')
    tags = {}
    with open(desc_fn, 'rt', encoding='UTF-8') as file:
        for section in apt_pkg.TagFile(file):
            tag = section['tag']
            tags[tag] = section
            for field in required_fields:
                if field not in section:
                    print('W: {tag}: required field {field} is missing'.format(tag=tag, field=field), file=sys.stderr)
            for field in section.keys():
                if field not in known_fields:
                    print('W: {tag}: unknown field {field}'.format(tag=tag, field=field), file=sys.stderr)
    obsolete_tags = set(tags)
    with open(code_fn, 'rt', encoding='UTF-8') as file:
        for line in file:
            match = tag_re.match(line)
            if match is None:
                continue
            for tag in match.group(1).split():
                if tag in obsolete_tags:
                    obsolete_tags.remove(tag)
                if tag in tags:
                    continue
                tags[tag] = 'Tag: {tag}\n'.format(tag=tag)
    with open(desc_fn + '+', 'wt', encoding='UTF-8') as file:
        for tag, section in sorted(tags.items()):
            print(section, file=file)
    os.rename(desc_fn + '+', desc_fn)
    for tag in sorted(obsolete_tags):
        print('W: {tag}: obsolete tag'.format(tag=tag), file=sys.stderr)

if __name__ == '__main__':
    main()

# vim:ts=4 sw=4 et
