This code provides sample, non-production-ready implementations of IPP Clients,
Printers, Proxies, and Systems. It makes use of the CUPS Library v3 and
PDFio library projects to provide low-level HTTP, IPP, and PDF support.
The ippserver
and ipp3dprinter
code was also inspired by the original CUPS
ippeveprinter
source code.
Note: This code is provided for educational purposes only. While we will make every effort to ensure the code is bug-free and regularly run the code through dynamic and static analysis tools, it is written for correctness, not performance, and so is not intended for use as a production solution. This code is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
From the Github sources, clone the repository with the --recurse-submodules
option or use the git submodule
commands:
git clone --recurse-submodules git@github.com:istopwg/ippsample.git
git clone git@github.com:istopwg/ippsample.git
git submodule init
git submodule update
When updating an already-cloned repository:
git pull
git submodule update
The IPP sample code uses a configure script on POSIX platforms to take care of any platform differences:
./configure OPTIONS
make
The following options are supported:
--enable-debug
: Enable debugging and debug logging.--disable-shared
: Disable shared libraries.--enable-maintainer
: Enable warnings as errors.--enable-sanitizer
: Enable address sanitizer.--enable-static
: Enable static libraries.--prefix=PATH
: Configure the installation directory, the default is/usr/local
.
On macOS, the "xcode" directory contains an Xcode workspace called "ippsample.xcworkspace" that can be used to build the code. Similarly, on Windows the "vcnet" directory contains a Visual Studio solution called "ippsample.sln" that can be used to build the code.
The "test" target runs all of the unit tests and a full-up "system" test of the various programs:
make test
The IPP sample code includes per-specification ipptool test files under the "examples" directory.
The ipp3dprinter
program implements a single IPP 3D printer and can be
configured to use a print command to do processing of document data.
The ippdoclint
program verifies and reports on document data. It is primarily
used for testing IPP Clients with the ippeveprinter
and ippserver
programs.
The ippproxy
program implements a generic IPP Proxy interface that allows you
to connect a local IPP or PCL printer to an IPP Infrastructure Printer such as
the ippserver
program.
The ippserver
program implements the IPP System Service and provides a generic
IPP Printer interface that allows you to host shared printers using the IPP
Shared Infrastructure Extensions as well as support local printing or document
processing.
The ipptransform
program is a generic file conversion utility that is used
primarily with ippeveprinter
and ippserver
to support transformation of
JPEG, PNG, PDF, and text documents to PDF or raster data for IPP Everywhere™
and HP PCL printers.
The ipptransform3d
program is a generic 3D file conversion utility that is
used primarily with ippserver
to support 3MF, G-code, and STL printing to 3D
printers using the CuraEngine software.
Copyright © 2014-2022 by the IEEE-ISTO Printer Working Group.
Copyright © 2007-2019 by Apple Inc.
Copyright © 1997-2007 by Easy Software Products.
This software is provided under the terms of the Apache License, Version 2.0.
A copy of this license can be found in the file LICENSE
. Additional legal
information is provided in the file NOTICE
.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.