mkmesonconf.py

Mon, 19 Aug 2024 21:17:49 -0500

author
Gary Kramlich <grim@reaperworld.com>
date
Mon, 19 Aug 2024 21:17:49 -0500
changeset 42884
5a7d425c9d1b
parent 42457
d9c2194dbc2b
permissions
-rwxr-xr-x

Add a typing-state property to Purple.Conversation

This property tracks the typing state of the libpurple user in the
conversation. User interfaces are expected to set this property to typing
whenever the user's input could be considered part of the message.

When the state changes to typing, a timeout will be added to set the state to
paused. This timeout is reset each time the property is set to typing again.

If that timeout expires, a new timeout will be added to set the state to none.

When the conversation is created, the typing-state properties on the
Conversation and the ConversationMember of the libpurple user are bound so
user interfaces can treat that ConversationMember like any other.

The conversation properties unit test was updated to verify that the property
plumbing is in place. However, no other unit tests were created as the timeouts
would add too much time to the tests.

Testing Done:
Ran the unit tests and temporarily added some code to pidgin to set the typing state and verified the timeouts worked as intended.

Reviewed at https://reviews.imfreedom.org/r/3409/

#!/usr/bin/env python3
#
# Purple - Internet Messaging Library
# Copyright (C) Pidgin Developers <devel@pidgin.im>
#
# Purple is the legal property of its developers, whose names are too numerous
# to list here.  Please refer to the COPYRIGHT file distributed with this
# source distribution.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, see <https://www.gnu.org/licenses/>.

"""
Produce meson-config.h in a build directory.

This should not really be run manually. It is used by Meson as a
post-configuration script to create meson-config.h which for now simply
contains information about the configuration used to create the build
directory.
"""

import html
import json
import os
import shlex
import subprocess
import sys


try:
    introspect = os.environ['MESONINTROSPECT']
except KeyError:
    print('Meson is too old; '
          'it does not set MESONINTROSPECT for postconf scripts.')
    sys.exit(1)
else:
    introspect = shlex.split(introspect)

# This is the top-most Meson build root.
try:
    build_root = os.environ['MESON_BUILD_ROOT']
except KeyError:
    print('Meson is too old; '
          'it does not set MESON_BUILD_ROOT for postconf scripts.')
    sys.exit(1)

# This is the build root for the Pidgin project itself, which may be different
# if it's used as a subproject.
project_build_root = sys.argv[1]


def tostr(obj):
    if isinstance(obj, str):
        return html.escape(repr(obj))
    else:
        return repr(obj)


def normalize_pidgin_option(option):
    """Promote Pidgin-as-subproject options to global options."""
    name = option['name']
    # Option names for subprojects are determined by the wrap file name + the
    # subproject option. Unfortunately, the wrap file name is determined by the
    # superproject, so we can't know what it is. Just assume it is something
    # semi-standard.
    if ':' in name and name.startswith('pidgin'):
        option['name'] = name.split(':')[1]
    return option


conf = subprocess.check_output(introspect + ['--buildoptions', build_root],
                               universal_newlines=True)
conf = json.loads(conf)

# Skip all subproject options, or else the config string explodes.
conf = [normalize_pidgin_option(option) for option in conf]
conf = [option for option in conf if ':' not in option['name']]

with open(os.path.join(project_build_root, 'meson-config.h'), 'w') as f:
    f.write('#include <purple.h>\n')
    f.write('const PurpleKeyValuePair MESON_ARGS[] = {\n')
    for option in sorted(conf, key=lambda x: x['name']):
        f.write('{ .key= "' + option['name'] + '",' +
                ' .value="' + tostr(option['value']) + '" },\n')
    f.write('{ .key=NULL, .value=NULL },\n')
    f.write('};\n')

mercurial