Add native PDF output support

Copilot · laeubi · commit 9d37b22cb44f · 2025-12-20T07:12:52.000+01:00
Currently if one wants to create a PDF file it requires external
libraries and as SWT does not allows an abstraction like Grahics2D in
AWT one can not export real content of SWT components (e.g. Canvas)
except exporting as an raster image or using some hacks.

This now introduce a new PDFDocument to enable direct
PDF generation from SWT widgets via Control.print(GC). This allows
applications to export widget content to PDF files using the standard
GC drawing API as well as even creating completely customized documents.
diff --git a/binaries/org.eclipse.swt.cocoa.macosx.aarch64/.settings/.api_filters b/binaries/org.eclipse.swt.cocoa.macosx.aarch64/.settings/.api_filters
@@ -196,12 +196,4 @@
             </message_arguments>
         </filter>
     </resource>
-    <resource path="META-INF/MANIFEST.MF">
-        <filter comment="Version is bumped for Eclipse 4.39 because of new BREE requirement" id="926941240">
-            <message_arguments>
-                <message_argument value="3.133.0"/>
-                <message_argument value="3.132.0"/>
-            </message_arguments>
-        </filter>
-    </resource>
 </component>
diff --git a/binaries/org.eclipse.swt.cocoa.macosx.x86_64/.settings/.api_filters b/binaries/org.eclipse.swt.cocoa.macosx.x86_64/.settings/.api_filters
@@ -196,12 +196,4 @@
             </message_arguments>
         </filter>
     </resource>
-    <resource path="META-INF/MANIFEST.MF">
-        <filter comment="Version is bumped for Eclipse 4.39 because of new BREE requirement" id="926941240">
-            <message_arguments>
-                <message_argument value="3.133.0"/>
-                <message_argument value="3.132.0"/>
-            </message_arguments>
-        </filter>
-    </resource>
 </component>
diff --git a/binaries/org.eclipse.swt.gtk.linux.aarch64/.settings/.api_filters b/binaries/org.eclipse.swt.gtk.linux.aarch64/.settings/.api_filters
@@ -204,12 +204,4 @@
             </message_arguments>
         </filter>
     </resource>
-    <resource path="META-INF/MANIFEST.MF">
-        <filter comment="Version is bumped for Eclipse 4.39 because of new BREE requirement" id="926941240">
-            <message_arguments>
-                <message_argument value="3.133.0"/>
-                <message_argument value="3.132.0"/>
-            </message_arguments>
-        </filter>
-    </resource>
 </component>
diff --git a/binaries/org.eclipse.swt.gtk.linux.loongarch64/.settings/.api_filters b/binaries/org.eclipse.swt.gtk.linux.loongarch64/.settings/.api_filters
@@ -204,12 +204,4 @@
             </message_arguments>
         </filter>
     </resource>
-    <resource path="META-INF/MANIFEST.MF">
-        <filter comment="Version is bumped for Eclipse 4.39 because of new BREE requirement" id="926941240">
-            <message_arguments>
-                <message_argument value="3.133.0"/>
-                <message_argument value="3.132.0"/>
-            </message_arguments>
-        </filter>
-    </resource>
 </component>
diff --git a/binaries/org.eclipse.swt.gtk.linux.ppc64le/.settings/.api_filters b/binaries/org.eclipse.swt.gtk.linux.ppc64le/.settings/.api_filters
@@ -204,12 +204,4 @@
             </message_arguments>
         </filter>
     </resource>
-    <resource path="META-INF/MANIFEST.MF">
-        <filter comment="Version is bumped for Eclipse 4.39 because of new BREE requirement" id="926941240">
-            <message_arguments>
-                <message_argument value="3.133.0"/>
-                <message_argument value="3.132.0"/>
-            </message_arguments>
-        </filter>
-    </resource>
 </component>
diff --git a/binaries/org.eclipse.swt.gtk.linux.riscv64/.settings/.api_filters b/binaries/org.eclipse.swt.gtk.linux.riscv64/.settings/.api_filters
@@ -204,12 +204,4 @@
             </message_arguments>
         </filter>
     </resource>
-    <resource path="META-INF/MANIFEST.MF">
-        <filter comment="Version is bumped for Eclipse 4.39 because of new BREE requirement" id="926941240">
-            <message_arguments>
-                <message_argument value="3.133.0"/>
-                <message_argument value="3.132.0"/>
-            </message_arguments>
-        </filter>
-    </resource>
 </component>
diff --git a/binaries/org.eclipse.swt.gtk.linux.x86_64/.settings/.api_filters b/binaries/org.eclipse.swt.gtk.linux.x86_64/.settings/.api_filters
@@ -204,12 +204,4 @@
             </message_arguments>
         </filter>
     </resource>
-    <resource path="META-INF/MANIFEST.MF">
-        <filter comment="Version is bumped for Eclipse 4.39 because of new BREE requirement" id="926941240">
-            <message_arguments>
-                <message_argument value="3.133.0"/>
-                <message_argument value="3.132.0"/>
-            </message_arguments>
-        </filter>
-    </resource>
 </component>
diff --git a/binaries/org.eclipse.swt.win32.win32.aarch64/.settings/.api_filters b/binaries/org.eclipse.swt.win32.win32.aarch64/.settings/.api_filters
@@ -315,12 +315,4 @@
             </message_arguments>
         </filter>
     </resource>
-    <resource path="META-INF/MANIFEST.MF">
-        <filter comment="Version is bumped for Eclipse 4.39 because of new BREE requirement" id="926941240">
-            <message_arguments>
-                <message_argument value="3.133.0"/>
-                <message_argument value="3.132.0"/>
-            </message_arguments>
-        </filter>
-    </resource>
 </component>
diff --git a/binaries/org.eclipse.swt.win32.win32.x86_64/.settings/.api_filters b/binaries/org.eclipse.swt.win32.win32.x86_64/.settings/.api_filters
@@ -315,12 +315,4 @@
             </message_arguments>
         </filter>
     </resource>
-    <resource path="META-INF/MANIFEST.MF">
-        <filter comment="Version is bumped for Eclipse 4.39 because of new BREE requirement" id="926941240">
-            <message_arguments>
-                <message_argument value="3.133.0"/>
-                <message_argument value="3.132.0"/>
-            </message_arguments>
-        </filter>
-    </resource>
 </component>
diff --git a/bundles/org.eclipse.swt/Eclipse SWT PI/cairo/library/cairo.c b/bundles/org.eclipse.swt/Eclipse SWT PI/cairo/library/cairo.c
@@ -15,7 +15,7 @@
  *
  * IBM
  * -  Binding to permit interfacing between Cairo and SWT
- * -  Copyright (C) 2005, 2022 IBM Corp.  All Rights Reserved.
+ * -  Copyright (C) 2005, 2025 IBM Corp.  All Rights Reserved.
  *
  * ***** END LICENSE BLOCK ***** */
 
@@ -704,6 +704,30 @@ JNIEXPORT void JNICALL Cairo_NATIVE(cairo_1pattern_1set_1matrix)
 }
 #endif
 
+#ifndef NO_cairo_1pdf_1surface_1create
+JNIEXPORT jlong JNICALL Cairo_NATIVE(cairo_1pdf_1surface_1create)
+	(JNIEnv *env, jclass that, jbyteArray arg0, jdouble arg1, jdouble arg2)
+{
+	jbyte *lparg0=NULL;
+	jlong rc = 0;
+	Cairo_NATIVE_ENTER(env, that, cairo_1pdf_1surface_1create_FUNC);
+	if (arg0) if ((lparg0 = (*env)->GetByteArrayElements(env, arg0, NULL)) == NULL) goto fail;
+/*
+	rc = (jlong)cairo_pdf_surface_create((const char *)lparg0, arg1, arg2);
+*/
+	{
+		Cairo_LOAD_FUNCTION(fp, cairo_pdf_surface_create)
+		if (fp) {
+			rc = (jlong)((jlong (CALLING_CONVENTION*)(const char *, jdouble, jdouble))fp)((const char *)lparg0, arg1, arg2);
+		}
+	}
+fail:
+	if (arg0 && lparg0) (*env)->ReleaseByteArrayElements(env, arg0, lparg0, 0);
+	Cairo_NATIVE_EXIT(env, that, cairo_1pdf_1surface_1create_FUNC);
+	return rc;
+}
+#endif
+
 #ifndef NO_cairo_1pdf_1surface_1set_1size
 JNIEXPORT void JNICALL Cairo_NATIVE(cairo_1pdf_1surface_1set_1size)
 	(JNIEnv *env, jclass that, jlong arg0, jdouble arg1, jdouble arg2)
diff --git a/bundles/org.eclipse.swt/Eclipse SWT PI/cairo/library/cairo_custom.h b/bundles/org.eclipse.swt/Eclipse SWT PI/cairo/library/cairo_custom.h
@@ -30,6 +30,7 @@
 #define cairo_ps_surface_set_size_LIB LIB_CAIRO
 #define cairo_surface_set_device_scale_LIB LIB_CAIRO
 #define cairo_surface_get_device_scale_LIB LIB_CAIRO
+#define cairo_pdf_surface_create_LIB LIB_CAIRO
 
 #ifdef CAIRO_HAS_XLIB_SURFACE
 #define cairo_xlib_surface_get_height_LIB LIB_CAIRO
diff --git a/bundles/org.eclipse.swt/Eclipse SWT PI/cairo/library/cairo_stats.h b/bundles/org.eclipse.swt/Eclipse SWT PI/cairo/library/cairo_stats.h
@@ -15,7 +15,7 @@
  *
  * IBM
  * -  Binding to permit interfacing between Cairo and SWT
- * -  Copyright (C) 2005, 2023 IBM Corp.  All Rights Reserved.
+ * -  Copyright (C) 2005, 2025 IBM Corp.  All Rights Reserved.
  *
  * ***** END LICENSE BLOCK ***** */
 
@@ -86,6 +86,7 @@ typedef enum {
 	cairo_1pattern_1set_1extend_FUNC,
 	cairo_1pattern_1set_1filter_FUNC,
 	cairo_1pattern_1set_1matrix_FUNC,
+	cairo_1pdf_1surface_1create_FUNC,
 	cairo_1pdf_1surface_1set_1size_FUNC,
 	cairo_1pop_1group_1to_1source_FUNC,
 	cairo_1ps_1surface_1set_1size_FUNC,
diff --git a/bundles/org.eclipse.swt/Eclipse SWT PI/cairo/org/eclipse/swt/internal/cairo/Cairo.java b/bundles/org.eclipse.swt/Eclipse SWT PI/cairo/org/eclipse/swt/internal/cairo/Cairo.java
@@ -418,4 +418,13 @@ public class Cairo extends Platform {
  */
 public static final native void memmove(double[] dest, long src, long size);
 
+/** Surface type constant for SVG */
+public static final int CAIRO_SURFACE_TYPE_SVG = 4;
+
+/**
+ * @method flags=dynamic
+ * @param filename cast=(const char *)
+ */
+public static final native long cairo_pdf_surface_create(byte[] filename, double width_in_points, double height_in_points);
+
 }
diff --git a/bundles/org.eclipse.swt/Eclipse SWT PI/cocoa/library/os.c b/bundles/org.eclipse.swt/Eclipse SWT PI/cocoa/library/os.c
@@ -1,15 +1,12 @@
 /*******************************************************************************
- * Copyright (c) 2000, 2022 IBM Corporation and others.
+ * Copyright (c) 2000, 2025 IBM Corporation and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
  * which accompanies this distribution, and is available at
  * https://www.eclipse.org/legal/epl-2.0/
  *
  * SPDX-License-Identifier: EPL-2.0
- *
- * Contributors:
- *    IBM Corporation - initial API and implementation
  *******************************************************************************/
 
 /* Note: This file was auto-generated by org.eclipse.swt.tools.internal.JNIGenerator */
@@ -1596,6 +1593,52 @@ JNIEXPORT void JNICALL OS_NATIVE(CGImageRelease)
 }
 #endif
 
+#ifndef NO_CGPDFContextBeginPage
+JNIEXPORT void JNICALL OS_NATIVE(CGPDFContextBeginPage)
+	(JNIEnv *env, jclass that, jlong arg0, jlong arg1)
+{
+	OS_NATIVE_ENTER(env, that, CGPDFContextBeginPage_FUNC);
+	CGPDFContextBeginPage((CGContextRef)arg0, (CFDictionaryRef)arg1);
+	OS_NATIVE_EXIT(env, that, CGPDFContextBeginPage_FUNC);
+}
+#endif
+
+#ifndef NO_CGPDFContextClose
+JNIEXPORT void JNICALL OS_NATIVE(CGPDFContextClose)
+	(JNIEnv *env, jclass that, jlong arg0)
+{
+	OS_NATIVE_ENTER(env, that, CGPDFContextClose_FUNC);
+	CGPDFContextClose((CGContextRef)arg0);
+	OS_NATIVE_EXIT(env, that, CGPDFContextClose_FUNC);
+}
+#endif
+
+#ifndef NO_CGPDFContextCreateWithURL
+JNIEXPORT jlong JNICALL OS_NATIVE(CGPDFContextCreateWithURL)
+	(JNIEnv *env, jclass that, jlong arg0, jobject arg1, jlong arg2)
+{
+	CGRect _arg1, *lparg1=NULL;
+	jlong rc = 0;
+	OS_NATIVE_ENTER(env, that, CGPDFContextCreateWithURL_FUNC);
+	if (arg1) if ((lparg1 = getCGRectFields(env, arg1, &_arg1)) == NULL) goto fail;
+	rc = (jlong)CGPDFContextCreateWithURL((CFURLRef)arg0, (const CGRect *)lparg1, (CFDictionaryRef)arg2);
+fail:
+	if (arg1 && lparg1) setCGRectFields(env, arg1, lparg1);
+	OS_NATIVE_EXIT(env, that, CGPDFContextCreateWithURL_FUNC);
+	return rc;
+}
+#endif
+
+#ifndef NO_CGPDFContextEndPage
+JNIEXPORT void JNICALL OS_NATIVE(CGPDFContextEndPage)
+	(JNIEnv *env, jclass that, jlong arg0)
+{
+	OS_NATIVE_ENTER(env, that, CGPDFContextEndPage_FUNC);
+	CGPDFContextEndPage((CGContextRef)arg0);
+	OS_NATIVE_EXIT(env, that, CGPDFContextEndPage_FUNC);
+}
+#endif
+
 #ifndef NO_CGPathAddCurveToPoint
 JNIEXPORT void JNICALL OS_NATIVE(CGPathAddCurveToPoint)
 	(JNIEnv *env, jclass that, jlong arg0, jlong arg1, jdouble arg2, jdouble arg3, jdouble arg4, jdouble arg5, jdouble arg6, jdouble arg7)
diff --git a/bundles/org.eclipse.swt/Eclipse SWT PI/cocoa/library/os_stats.h b/bundles/org.eclipse.swt/Eclipse SWT PI/cocoa/library/os_stats.h
@@ -1,15 +1,12 @@
 /*******************************************************************************
- * Copyright (c) 2000, 2023 IBM Corporation and others.
+ * Copyright (c) 2000, 2025 IBM Corporation and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
  * which accompanies this distribution, and is available at
  * https://www.eclipse.org/legal/epl-2.0/
  *
  * SPDX-License-Identifier: EPL-2.0
- *
- * Contributors:
- *    IBM Corporation - initial API and implementation
  *******************************************************************************/
 
 /* Note: This file was auto-generated by org.eclipse.swt.tools.internal.JNIGenerator */
@@ -117,6 +114,10 @@ typedef enum {
 	CGImageGetHeight_FUNC,
 	CGImageGetWidth_FUNC,
 	CGImageRelease_FUNC,
+	CGPDFContextBeginPage_FUNC,
+	CGPDFContextClose_FUNC,
+	CGPDFContextCreateWithURL_FUNC,
+	CGPDFContextEndPage_FUNC,
 	CGPathAddCurveToPoint_FUNC,
 	CGPathAddLineToPoint_FUNC,
 	CGPathApply_FUNC,
diff --git a/bundles/org.eclipse.swt/Eclipse SWT PI/cocoa/org/eclipse/swt/internal/cocoa/OS.java b/bundles/org.eclipse.swt/Eclipse SWT PI/cocoa/org/eclipse/swt/internal/cocoa/OS.java
@@ -3198,6 +3198,25 @@ public static Selector getSelector (long value) {
  * @param image cast=(CGImageRef)
  */
 public static final native void CGImageRelease(long image);
+/**
+ * @param url cast=(CFURLRef)
+ * @param mediaBox cast=(const CGRect *)
+ * @param auxiliaryInfo cast=(CFDictionaryRef)
+ */
+public static final native long CGPDFContextCreateWithURL(long url, CGRect mediaBox, long auxiliaryInfo);
+/**
+ * @param context cast=(CGContextRef)
+ * @param pageInfo cast=(CFDictionaryRef)
+ */
+public static final native void CGPDFContextBeginPage(long context, long pageInfo);
+/**
+ * @param context cast=(CGContextRef)
+ */
+public static final native void CGPDFContextEndPage(long context);
+/**
+ * @param context cast=(CGContextRef)
+ */
+public static final native void CGPDFContextClose(long context);
 /**
  * @param path cast=(CGMutablePathRef)
  * @param m cast=(CGAffineTransform*)
diff --git a/bundles/org.eclipse.swt/Eclipse SWT PI/win32/org/eclipse/swt/internal/win32/OS.java b/bundles/org.eclipse.swt/Eclipse SWT PI/win32/org/eclipse/swt/internal/win32/OS.java
@@ -337,7 +337,18 @@ public class OS extends C {
 	public static final int DM_COPIES = 0x00000100;
 	public static final int DM_DUPLEX = 0x00001000;
 	public static final int DM_ORIENTATION = 0x00000001;
+	public static final int DM_PAPERSIZE = 0x00000002;
+	public static final int DM_PAPERLENGTH = 0x00000004;
+	public static final int DM_PAPERWIDTH = 0x00000008;
 	public static final int DM_OUT_BUFFER = 2;
+	public static final short DMPAPER_LETTER = 1;
+	public static final short DMPAPER_LEGAL = 5;
+	public static final short DMPAPER_EXECUTIVE = 7;
+	public static final short DMPAPER_A3 = 8;
+	public static final short DMPAPER_A4 = 9;
+	public static final short DMPAPER_A5 = 11;
+	public static final short DMPAPER_TABLOID = 3;
+	public static final short DMPAPER_USER = 256;
 	public static final short DMORIENT_PORTRAIT = 1;
 	public static final short DMORIENT_LANDSCAPE = 2;
 	public static final short DMDUP_SIMPLEX = 1;
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Printing/cocoa/org/eclipse/swt/printing/PDFDocument.java b/bundles/org.eclipse.swt/Eclipse SWT Printing/cocoa/org/eclipse/swt/printing/PDFDocument.java
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Printing/gtk/org/eclipse/swt/printing/PDFDocument.java b/bundles/org.eclipse.swt/Eclipse SWT Printing/gtk/org/eclipse/swt/printing/PDFDocument.java
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Printing/win32/org/eclipse/swt/printing/PDFDocument.java b/bundles/org.eclipse.swt/Eclipse SWT Printing/win32/org/eclipse/swt/printing/PDFDocument.java
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Shell.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Shell.java
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Shell.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Shell.java
diff --git a/examples/org.eclipse.swt.snippets/src/org/eclipse/swt/snippets/Snippet388.java b/examples/org.eclipse.swt.snippets/src/org/eclipse/swt/snippets/Snippet388.java
diff --git a/tests/org.eclipse.swt.tests/JUnit Tests/org/eclipse/swt/tests/junit/AllNonBrowserTests.java b/tests/org.eclipse.swt.tests/JUnit Tests/org/eclipse/swt/tests/junit/AllNonBrowserTests.java
diff --git a/tests/org.eclipse.swt.tests/JUnit Tests/org/eclipse/swt/tests/junit/Test_org_eclipse_swt_printing_PDFDocument.java b/tests/org.eclipse.swt.tests/JUnit Tests/org/eclipse/swt/tests/junit/Test_org_eclipse_swt_printing_PDFDocument.java
