Merge pull request #89070 from kalbasit/nixpkgs_add-nanopb

nanopb: init at 0.4.1
This commit is contained in:
Wael Nasreddine 2020-06-16 07:22:08 -07:00 committed by GitHub
commit 15a059bba2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 218 additions and 0 deletions

View file

@ -0,0 +1,88 @@
{ callPackage
, cmake
, fetchFromGitHub
, lib
, protobuf
, python3
, stdenv
}:
let
pythonRuntime = python3.withPackages(ps: [ ps.protobuf ]);
in stdenv.mkDerivation rec {
pname = "nanopb";
version = "0.4.1";
src = fetchFromGitHub {
owner = pname;
repo = pname;
rev = version;
sha256 = "16zxk42wzn519bpxf4578qn97k0h1cnbkvqqkqvka9sl0n3lz2dp";
};
nativeBuildInputs = [ cmake python3 ];
cmakeFlags = [
"-DBUILD_SHARED_LIBS=ON" # generate $out/lib/libprotobuf-nanopb.so{.0,}
"-DBUILD_STATIC_LIBS=ON" # generate $out/lib/libprotobuf-nanopb.a
"-Dnanopb_PROTOC_PATH=${protobuf}/bin/protoc"
];
# On a case-insensitive filesystem (such as on Darwin), CMake fails to create
# the build directory because of the existence of the BUILD file.
# TODO: This can be removed once https://github.com/nanopb/nanopb/pull/537 is merged.
preConfigure = "rm BUILD";
# install the generator which requires Python3 with the protobuf package. It
# also requires the nanopb module that's generated by CMake to be in a
# relative location to the generator itself so we move it out of the
# python.sitePackages into the shared generator folder.
postInstall = ''
mkdir -p $out/share/nanopb/generator/proto
cp ../generator/nanopb_generator.py $out/share/nanopb/generator/nanopb_generator.py
cp ../generator/proto/_utils.py $out/share/nanopb/generator/proto/_utils.py
cp ../generator/proto/nanopb.proto $out/share/nanopb/generator/proto/nanopb.proto
mv $out/${python3.sitePackages}/nanopb_pb2.py $out/share/nanopb/generator/proto
rm -rf $out/${python3.sitePackages}
mkdir $out/bin
substitute ${./protoc-gen-nanopb} $out/bin/protoc-gen-nanopb \
--subst-var-by python ${pythonRuntime}/bin/python \
--subst-var-by out $out
chmod +x $out/bin/protoc-gen-nanopb
'';
passthru.tests = {
simple-proto2 = callPackage ./test-simple-proto2 {};
simple-proto3 = callPackage ./test-simple-proto3 {};
message-with-annotations = callPackage ./test-message-with-annotations {};
message-with-options = callPackage ./test-message-with-options {};
};
meta = with lib; {
inherit (protobuf.meta) platforms;
description = "Protocol Buffers with small code size";
homepage = "https://jpa.kapsi.fi/nanopb/";
license = licenses.zlib;
maintainers = with maintainers; [ kalbasit ];
longDescription = ''
Nanopb is a small code-size Protocol Buffers implementation in ansi C. It
is especially suitable for use in microcontrollers, but fits any memory
restricted system.
- Homepage: jpa.kapsi.fi/nanopb
- Documentation: jpa.kapsi.fi/nanopb/docs
- Downloads: jpa.kapsi.fi/nanopb/download
- Forum: groups.google.com/forum/#!forum/nanopb
In order to use the nanopb options in your proto files, you'll need to
tell protoc where to find the nanopb.proto file.
You can do so with the --proto_path (-I) option to add the directory
''${nanopb}/share/nanopb/generator/proto like so:
protoc --proto_path=. --proto_path=''${nanopb}/share/nanopb/generator/proto --plugin=protoc-gen-nanopb=''${nanopb}/bin/protoc-gen-nanopb --nanopb_out=out file.proto
'';
};
}

View file

@ -0,0 +1,3 @@
#!/usr/bin/env bash
exec @python@ @out@/share/nanopb/generator/nanopb_generator.py --protoc-plugin

View file

@ -0,0 +1,27 @@
{ stdenv, protobuf, nanopb }:
stdenv.mkDerivation {
name = "nanopb-test-message-with-annotations";
meta.timeout = 60;
src = ./.;
# protoc requires any .proto file to be compiled to reside within it's
# proto_path. By default the current directory is automatically added to the
# proto_path. I tried using --proto_path ${./.} ${./simple.proto} and it did
# not work because they end up in the store at different locations.
installPhase = ":";
buildPhase = ''
mkdir $out
${protobuf}/bin/protoc --proto_path=. --proto_path=${nanopb}/share/nanopb/generator/proto --plugin=protoc-gen-nanopb=${nanopb}/bin/protoc-gen-nanopb --nanopb_out=$out withannotations.proto
'';
docheck = true;
checkphase = ''
grep -q WithAnnotations $out/withannotations.pb.c || (echo "error: WithAnnotations not found in $out/withannotations.pb.c"; exit 1)
grep -q WithAnnotations $out/withannotations.pb.h || (echo "error: WithAnnotations not found in $out/withannotations.pb.h"; exit 1)
grep -q "pb_byte_t uuid\[16\]" $out/withannotations.pb.h || (echo "error: uuid is not of type pb_byte_t and of size 16 in $out/withannotations.pb.h"; exit 1)
grep -q "FIXED_LENGTH_BYTES, uuid" $out/withannotations.pb.h || (echo "error: uuid is not of fixed lenght bytes in $out/withannotations.pb.h"; exit 1)
grep -q "#define WithAnnotations_size" $out/withannotations.pb.h || (echo "error: the size of WithAnnotations is not known in $out/withannotations.pb.h"; exit 1)
'';
}

View file

@ -0,0 +1,7 @@
syntax = "proto3";
import "nanopb.proto";
message WithAnnotations {
bytes uuid = 1 [(nanopb).max_size = 16, (nanopb).fixed_length = true];
}

View file

@ -0,0 +1,27 @@
{ stdenv, protobuf, nanopb }:
stdenv.mkDerivation {
name = "nanopb-test-message-with-options";
meta.timeout = 60;
src = ./.;
# protoc requires any .proto file to be compiled to reside within it's
# proto_path. By default the current directory is automatically added to the
# proto_path. I tried using --proto_path ${./.} ${./simple.proto} and it did
# not work because they end up in the store at different locations.
installPhase = ":";
buildPhase = ''
mkdir $out
${protobuf}/bin/protoc --plugin=protoc-gen-nanopb=${nanopb}/bin/protoc-gen-nanopb --nanopb_out=$out withoptions.proto
'';
docheck = true;
checkphase = ''
grep -q WithOptions $out/withoptions.pb.c || (echo "error: WithOptions not found in $out/withoptions.pb.c"; exit 1)
grep -q WithOptions $out/withoptions.pb.h || (echo "error: WithOptions not found in $out/withoptions.pb.h"; exit 1)
grep -q "pb_byte_t uuid\[16\]" $out/withoptions.pb.h || (echo "error: uuid is not of type pb_byte_t and of size 16 in $out/withoptions.pb.h"; exit 1)
grep -q "FIXED_LENGTH_BYTES, uuid" $out/withoptions.pb.h || (echo "error: uuid is not of fixed lenght bytes in $out/withoptions.pb.h"; exit 1)
grep -q "#define WithOptions_size" $out/withoptions.pb.h || (echo "error: the size of WithOptions is not known in $out/withoptions.pb.h"; exit 1)
'';
}

View file

@ -0,0 +1 @@
WithOptions.uuid max_size:16 fixed_length:true

View file

@ -0,0 +1,5 @@
syntax = "proto3";
message WithOptions {
bytes uuid = 1;
}

View file

@ -0,0 +1,24 @@
{ stdenv, protobuf, nanopb }:
stdenv.mkDerivation {
name = "nanopb-test-simple-proto2";
meta.timeout = 60;
src = ./.;
# protoc requires any .proto file to be compiled to reside within it's
# proto_path. By default the current directory is automatically added to the
# proto_path. I tried using --proto_path ${./.} ${./simple.proto} and it did
# not work because they end up in the store at different locations.
installPhase = ":";
buildPhase = ''
mkdir $out
${protobuf}/bin/protoc --plugin=protoc-gen-nanopb=${nanopb}/bin/protoc-gen-nanopb --nanopb_out=$out simple.proto
'';
doCheck = true;
checkPhase = ''
grep -q SimpleMessage $out/simple.pb.c || (echo "ERROR: SimpleMessage not found in $out/simple.pb.c"; exit 1)
grep -q SimpleMessage $out/simple.pb.h || (echo "ERROR: SimpleMessage not found in $out/simple.pb.h"; exit 1)
'';
}

View file

@ -0,0 +1,5 @@
syntax = "proto2";
message SimpleMessage {
required int32 lucky_number = 1;
}

View file

@ -0,0 +1,24 @@
{ stdenv, protobuf, nanopb }:
stdenv.mkDerivation {
name = "nanopb-test-simple-proto3";
meta.timeout = 60;
src = ./.;
# protoc requires any .proto file to be compiled to reside within it's
# proto_path. By default the current directory is automatically added to the
# proto_path. I tried using --proto_path ${./.} ${./simple.proto} and it did
# not work because they end up in the store at different locations.
installPhase = ":";
buildPhase = ''
mkdir $out
${protobuf}/bin/protoc --plugin=protoc-gen-nanopb=${nanopb}/bin/protoc-gen-nanopb --nanopb_out=$out simple.proto
'';
doCheck = true;
checkPhase = ''
grep -q SimpleMessage $out/simple.pb.c || (echo "ERROR: SimpleMessage not found in $out/simple.pb.c"; exit 1)
grep -q SimpleMessage $out/simple.pb.h || (echo "ERROR: SimpleMessage not found in $out/simple.pb.h"; exit 1)
'';
}

View file

@ -0,0 +1,5 @@
syntax = "proto3";
message SimpleMessage {
int32 lucky_number = 1;
}

View file

@ -14213,6 +14213,8 @@ in
flatbuffers = callPackage ../development/libraries/flatbuffers { };
nanopb = callPackage ../development/libraries/nanopb { };
gnupth = callPackage ../development/libraries/pth { };
pth = if stdenv.hostPlatform.isMusl then npth else gnupth;