README
README.OpenSource
1[
2 {
3 "Name": "openEuler:glib2",
4 "License": "LGPL V2.1",
5 "License File": "COPYING",
6 "Version Number": "2.72.2-12.oe2203sp3",
7 "Upstream URL": "https://www.gtk.org/",
8 "Description": "GLib is the low-level core library that forms the basis for projects such as GTK and GNOME. It provides data structure handling for C, portability wrappers, and interfaces for such runtime functionality as an event loop, threads, dynamic loading, and an object system."
9 }
10]
11
README.md
1# GLib
2
3GLib is the low-level core library that forms the basis for projects such
4as GTK and GNOME. It provides data structure handling for C, portability
5wrappers, and interfaces for such runtime functionality as an event loop,
6threads, dynamic loading, and an object system.
7
8The official download locations are:
9 <https://download.gnome.org/sources/glib>
10
11The official web site is:
12 <https://www.gtk.org/>
13
14## Installation
15
16See the file '[INSTALL.in](INSTALL.in)'
17
18## Supported versions
19
20Only the most recent unstable and stable release series are supported. All
21older versions are not supported upstream and may contain bugs, some of
22which may be exploitable security vulnerabilities.
23
24See [SECURITY.md](SECURITY.md) for more details.
25
26## Documentation
27
28API documentation is available online for GLib for the:
29 * [GLib](https://docs.gtk.org/glib/)
30 * [GObject](https://docs.gtk.org/gobject/)
31 * [GModule](https://docs.gtk.org/gmodule/)
32 * [GIO](https://docs.gtk.org/gio/)
33
34## Discussion
35
36If you have a question about how to use GLib, seek help on [GNOME’s Discourse
37instance](https://discourse.gnome.org/tags/glib). Alternatively, ask a question
38on [StackOverflow and tag it `glib`](https://stackoverflow.com/questions/tagged/glib).
39
40## Reporting bugs
41
42Bugs should be [reported to the GNOME issue tracking system](https://gitlab.gnome.org/GNOME/glib/issues/new).
43You will need to create an account for yourself. You may also submit bugs by
44e-mail (without an account) by e-mailing <incoming+gnome-glib-658-issue-@gitlab.gnome.org>,
45but this will give you a degraded experience.
46
47Bugs are for reporting problems in GLib itself, not for asking questions about
48how to use it. To ask questions, use one of our [discussion forums](#discussion).
49
50In bug reports please include:
51
52* Information about your system. For instance:
53 * What operating system and version
54 * For Linux, what version of the C library
55 * And anything else you think is relevant.
56* How to reproduce the bug.
57 * If you can reproduce it with one of the test programs that are built
58 in the `tests/` subdirectory, that will be most convenient. Otherwise,
59 please include a short test program that exhibits the behavior.
60 As a last resort, you can also provide a pointer to a larger piece
61 of software that can be downloaded.
62* If the bug was a crash, the exact text that was printed out
63 when the crash occurred.
64* Further information such as stack traces may be useful, but
65 is not necessary.
66
67## Contributing to GLib
68
69Please follow the [contribution guide](./CONTRIBUTING.md) to know how to
70start contributing to GLib.
71
72Patches should be [submitted as merge requests](https://gitlab.gnome.org/GNOME/glib/-/merge_requests/new)
73to gitlab.gnome.org. If the patch fixes an existing issue, please refer to the
74issue in your commit message with the following notation (for issue 123):
75```
76Closes: #123
77```
78
79Otherwise, create a new merge request that introduces the change. Filing a
80separate issue is not required.
81
82## Default branch renamed to `main`
83
84The default development branch of GLib has been renamed to `main`. To update
85your local checkout, use:
86```sh
87git checkout master
88git branch -m master main
89git fetch
90git branch --unset-upstream
91git branch -u origin/main
92git symbolic-ref refs/remotes/origin/HEAD refs/remotes/origin/main
93```
94
README.rationale
1This file documents various major decisions which affect GLib development,
2giving a brief rationale of each decision, plus a link to further discussion.
3
4
5 * Compiler attributes: https://bugzilla.gnome.org/show_bug.cgi?id=113075#c46
6
7 GLib uses GIR annotations instead of compiler attributes. They are tidier,
8 already supported by GLib and GNOME tools, and accomplish the same task as
9 compiler attributes. GLib does not provide macros for attributes like
10 nonnull because it would not use them.
11
12 * Main loop API:
13
14 The ID-based mainloop APIs (g_idle_add, g_timeout_add, etc) are considered
15 legacy, and new features (such as g_source_set_static_name) will only be
16 added to the explicit GSource APIs.
17
README.win32
README.win32.md
1Chun-wei Fan `<fanc999@yahoo.com.tw>`
2Philip Withnall `<withnall@endlessm.com>`
3Nirbheek Chauhan `<nirbheek@centricular.com>`
4
5This document was last updated in 2019. You're reading this in the future, and
6lots of information might be misleading or outdated in your age. You have been
7warned.
8
9# General
10
11For prebuilt binaries (DLLs and EXEs) and developer packages (headers,
12import libraries) of GLib, Pango, GTK+ etc for Windows, go to
13https://www.gtk.org/download/windows.php . They are for "native"
14Windows meaning they use the Win32 API and Microsoft C runtime library
15only. No POSIX (Unix) emulation layer like Cygwin is involved.
16
17To build GLib on Win32, you can use either GCC ("MinGW") or the Microsoft
18Visual Studio toolchain. For the latter, Visual Studio 2015 and later are
19recommended. For older Visual Studio versions, see below.
20
21You can also cross-compile GLib for Windows from Linux using the
22cross-compiling mingw packages for your distro.
23
24Note that to just *use* GLib on Windows, there is no need to build it
25yourself.
26
27On Windows setting up a correct build environment is very similar to typing
28`meson; ninja` like on Linux.
29
30The following preprocessor macros are to be used for conditional
31compilation related to Win32 in GLib-using code:
32
33- `G_OS_WIN32` is defined when compiling for native Win32, without
34 any POSIX emulation, other than to the extent provided by the
35 bundled Microsoft C library.
36
37- `G_WITH_CYGWIN` is defined if compiling for the Cygwin
38 environment. Note that `G_OS_WIN32` is *not* defined in that case, as
39 Cygwin is supposed to behave like Unix. `G_OS_UNIX` *is* defined by a GLib
40 for Cygwin.
41
42- `G_PLATFORM_WIN32` is defined when either `G_OS_WIN32` or `G_WITH_CYGWIN`
43 is defined.
44
45These macros are defined in `glibconfig.h`, and are thus available in
46all source files that include `<glib.h>`.
47
48Additionally, there are the compiler-specific macros:
49- `__GNUC__` is defined when using GCC or Clang
50- `__clang__` is defined when using Clang or Clang-CL
51- `_MSC_VER` is defined when using MSVC or Clang-CL
52
53`G_OS_WIN32` implies using the Microsoft C runtime, which used to be
54`msvcrt.dll` and is now the [Universal CRT](https://docs.microsoft.com/en-us/cpp/c-runtime-library/crt-library-features?view=vs-2015)
55when building with Visual Studio. When using the MinGW-GCC toolchain, the CRT
56in use depends on the settings used while the toolchain was built. We highly
57recommend [using the Universal CRT when building with
58MinGW](https://mingwpy.github.io/ucrt.html) too.
59
60GLib is not actively tested with the static versions of the UCRT, but if you
61need to use those, patches are welcome.
62
63# Building software that use GLib or GTK+
64
65Building software that just *uses* GLib or GTK+ also require to have
66the right compiler set up the right way. If you intend to use MinGW-GCC,
67follow the relevant instructions below in that case, too.
68
69You should link to GLib using the `-mms-bitfields` GCC flag. This flag means
70that the struct layout rules are identical to those used by MSVC. This is
71essential if the same DLLs are to be usable both from gcc- and MSVC-compiled
72code.
73
74## Cross-CRT issues
75
76You should take care that the DLLs that your code links to are using the same
77C runtime library. Not doing so can and likely will lead to panics and crashes
78**unless** you're very careful while passing objects allocated by a library
79linked with one CRT to a library linked to another CRT, or (more commonly) not
80doing that at all.
81
82If you *do* pass CRT objects across CRT boundaries, do not file any issues
83about whatever happens next.
84
85To give an example, opening a `FILE` handle created by one CRT cannot be
86understood by any other CRT, and will lead to an access violation. You also
87cannot allocate memory in one CRT and free it using another.
88
89There are [many other cases where you must not allow objects to cross CRT boundaries](https://docs.microsoft.com/en-us/cpp/c-runtime-library/potential-errors-passing-crt-objects-across-dll-boundaries?view=vs-2019),
90but in theory if you're **very very** careful, you can make things work. Again,
91please do not come to us for help if you choose to do this.
92
93# Building GLib
94
95You can build GLib with MinGW-GCC, MSVC, or (experimentally) with Clang-CL.
96
97For all compilers, you will need the following:
98
99- Install Python 3.6.x or newer, either 32-bit or 64-bit. We recommend enabling
100 the option to add it to your `PATH`.
101- [Install Meson](https://mesonbuild.com/Getting-meson.html)
102- Install the [Ninja build tool](https://github.com/ninja-build/ninja/releases), which can also be
103 installed with `pip3`. You can skip this step if you want to generate Visual
104 Studio project files.
105- [git for Windows](https://gitforwindows.org/) is required, since Meson makes
106 use of git to download dependencies using subprojects.
107
108## Building with MinGW-GCC
109
110Open your MSYS or [MSYS2](https://www.msys2.org/) shell where you have the
111MinGW-GCC toolchain installed, and build GLib [like any other Meson
112project](https://mesonbuild.com/Quick-guide.html#compiling-a-meson-project).
113
114## Building with Visual Studio 2015 or newer
115
116Meson is now the only supported method of building GLib using Visual Studio.
117
118To do a build using Meson, do the following:
119
120- Open a Visual Studio (or SDK) command prompt that matches the Visual Studio
121 version and build platform (Win32/x86, x64, etc.) that will be used in all
122 the following steps.
123
124- Create an empty directory/folder for the build inside your GLib sources
125 directory, say, `_builddir`, and `cd` into it.
126
127- Set up the build using Meson:
128
129```cmd
130> meson .. --buildtype=<release|debug|debugoptimized> --prefix=<path> [--backend=vs]
131```
132
133 Please see [the Meson docs](https://mesonbuild.com/Builtin-options.html#core-options)
134 for an explanation for `--buildtype`.
135
136 The path passed for `--prefix` need not to be on the same drive as where the
137 build is carried out, but it is recommended to use forward slashes for this
138 path. The `--backend=vs` option can be used if the Visual Studio project
139 generator is preferred over using Ninja.
140
141- Build, test and install the build:
142 Run `ninja` to build, `meson test` to test and `meson install` to install the
143 build. If you used `--backend=vs`, instead of running `ninja`, you need to
144 use `msbuild` or you can open the generated solution in Visual Studio.
145
146## Building with old versions of Visual Studio
147
148The steps are the same as above, with the following notes about issues that you might face.
149
150### C4819 build errors
151
152If you are building GLib-based libraries or applications, or GLib itself
153and you see a `C4819` error (or warning, before `C4819` is treated as an error
154in `msvc_recommended_pragmas.h`), please be advised that this error/warning should
155not be disregarded, as this likely means portions of the build are not being
156done correctly, as this is an issue of Visual Studio running on CJK (East Asian)
157locales. This is an issue that also affects builds of other projects, such as
158QT, Firefox, LibreOffice/OpenOffice, Pango and GTK, along with many other projects.
159
160To overcome this problem, please set your system's locale setting for non-Unicode to
161English (United States), reboot, and restart the build, and the code should build
162normally.
163
164### Support for pre-2012 Visual Studio
165
166This release of GLib requires at least the Windows 8 SDK in order to be built
167successfully using Visual Studio, which means that it is no longer supported to
168build GLib with Visual Studio 2008 nor 2010. People that still need to use
169Visual Studio 2008 or 2010 should continue to use glib-2.66.x.
170