Adding a .ycm_extra_conf file for webkitGtk
[WebKit-https.git] / Tools / gtk / common.py
1 #!/usr/bin/env python
2 # Copyright (C) 2011 Igalia S.L.
3 #
4 # This library is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU Lesser General Public
6 # License as published by the Free Software Foundation; either
7 # version 2 of the License, or (at your option) any later version.
8 #
9 # This library is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 # Lesser General Public License for more details.
13 #
14 # You should have received a copy of the GNU Lesser General Public
15 # License along with this library; if not, write to the Free Software
16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
17
18 import errno
19 import os
20 import select
21 import subprocess
22 import sys
23
24 script_dir = None
25 build_dir = None
26
27
28 def script_path(*args):
29     global script_dir
30     if not script_dir:
31         script_dir = os.path.join(os.path.dirname(__file__), '..', 'Scripts')
32     return os.path.join(*(script_dir,) + args)
33
34
35 def top_level_path(*args):
36     return os.path.join(*((os.path.join(os.path.dirname(__file__), '..', '..'),) + args))
37
38
39 def get_build_path(build_types=('Release', 'Debug'), fatal=True):
40     global build_dir
41     if build_dir:
42         return build_dir
43
44     def is_valid_build_directory(path):
45         return os.path.exists(os.path.join(path, 'GNUmakefile')) or \
46             os.path.exists(os.path.join(path, 'Programs', 'DumpRenderTree'))
47
48     if len(sys.argv[1:]) > 1 and os.path.exists(sys.argv[-1]) and is_valid_build_directory(sys.argv[-1]):
49         return sys.argv[-1]
50
51     # Debian and Ubuntu build both flavours of the library (with gtk2
52     # and with gtk3); they use directories build-2.0 and build-3.0 for
53     # that, which is not handled by the above cases; we check that the
54     # directory where we are called from is a valid build directory,
55     # which should handle pretty much all other non-standard cases.
56     build_dir = os.getcwd()
57     if is_valid_build_directory(build_dir):
58         return build_dir
59
60     for build_type in build_types:
61         build_dir = top_level_path('WebKitBuild', build_type)
62         if is_valid_build_directory(build_dir):
63             return build_dir
64
65     # distcheck builds in a directory named _build in the top-level path.
66     build_dir = top_level_path("_build")
67     if is_valid_build_directory(build_dir):
68         return build_dir
69
70     build_dir = top_level_path()
71     if is_valid_build_directory(build_dir):
72         return build_dir
73
74     build_dir = top_level_path("WebKitBuild")
75     if is_valid_build_directory(build_dir):
76         return build_dir
77
78     print('Could not determine build directory.')
79     if fatal:
80         sys.exit(1)
81
82
83 def build_path_for_build_types(build_types, *args):
84     return os.path.join(*(get_build_path(build_types),) + args)
85
86
87 def build_path(*args):
88     return build_path_for_build_types(('Release', 'Debug'), *args)
89
90
91 def pkg_config_file_variable(package, variable):
92     process = subprocess.Popen(['pkg-config', '--variable=%s' % variable, package],
93                                stdout=subprocess.PIPE)
94     stdout = process.communicate()[0].decode("utf-8")
95     if process.returncode:
96         return None
97     return stdout.strip()
98
99
100 def prefix_of_pkg_config_file(package):
101     return pkg_config_file_variable(package, 'prefix')
102
103
104 def gtk_version_of_pkg_config_file(pkg_config_path):
105     process = subprocess.Popen(['pkg-config', pkg_config_path, '--print-requires'],
106                                stdout=subprocess.PIPE)
107     stdout = process.communicate()[0].decode("utf-8")
108
109     if 'gtk+-3.0' in stdout:
110         return 3
111     return 2
112
113
114 def parse_output_lines(fd, parse_line_callback):
115     output = ''
116     read_set = [fd]
117     while read_set:
118         try:
119             rlist, wlist, xlist = select.select(read_set, [], [])
120         except select.error as e:
121             parse_line_callback("WARNING: error while waiting for fd %d to become readable\n" % fd)
122             parse_line_callback("    error code: %d, error message: %s\n" % (e[0], e[1]))
123             continue
124
125         if fd in rlist:
126             try:
127                 chunk = os.read(fd, 1024)
128             except OSError as e:
129                 if e.errno == errno.EIO:
130                     # Child process finished.
131                     chunk = ''
132                 else:
133                     raise e
134             if not chunk:
135                 read_set.remove(fd)
136
137             output += chunk
138             while '\n' in output:
139                 pos = output.find('\n')
140                 parse_line_callback(output[:pos + 1])
141                 output = output[pos + 1:]
142
143             if not chunk and output:
144                 parse_line_callback(output)
145                 output = ''