[c++/m] Add Source findSources function

Closes #99

Author: mpsonntag

+nix/Source.m

@@ -78,5 +78,31 @@
             filtered = nix.Utils.filter(obj, filter, val, ...
                 'Source::sourcesFiltered', @nix.Source);
         end
+
+        % maxdepth is an index where idx = 0 corresponds to the calling
+        % source
+        function sec = find_sources(obj, max_depth)
+            sec = obj.find_filtered_sources(max_depth, nix.Filter.accept_all, '');
+        end
+
+        % maxdepth is an index where idx = 0 corresponds to the calling
+        % source
+        function sec = find_filtered_sources(obj, max_depth, filter, val)
+            if (~isnumeric(max_depth))
+                error('Provide a valid search depth');
+            end
+
+            valid = nix.Utils.valid_filter(filter, val);
+            if(~isempty(valid))
+                error(valid);
+            end
+
+            ret = nix_mx('Source::findSources', obj.nix_handle, ...
+                                            max_depth, uint8(filter), val);
+            sec = cell(length(ret), 1);
+            for i = 1:length(ret)
+                sec{i} = nix.Source(ret{i});
+            end;
+        end
     end;
 end

nix_mx.cc

@@ -287,6 +287,7 @@ void mexFunction(int            nlhs,
         methods->add("Source::openSourceIdx", nixsource::openSourceIdx);
         methods->add("Source::compare", nixsource::compare);
         methods->add("Source::sourcesFiltered", nixsource::sourcesFiltered);
+        methods->add("Source::findSources", nixsource::findSources);
 
         classdef<nix::Tag>("Tag", methods)
             .desc(&nixtag::describe)

src/nixsource.cc

@@ -49,4 +49,17 @@ namespace nixsource {
         output.set(0, res);
     }
 
+    void findSources(const extractor &input, infusor &output) {
+        nix::Source currObj = input.entity<nix::Source>(1);
+        size_t max_depth = (size_t)input.num<double>(2);
+        uint8_t filter_id = input.num<uint8_t>(3);
+
+        std::vector<nix::Source> res = filterFullEntity<nix::Source>(input, filter_id, 4, max_depth,
+            [currObj](const nix::util::Filter<nix::Source>::type &filter, size_t &md) {
+                return currObj.findSources(filter, md);
+        });
+
+        output.set(0, res);
+    }
+
 } // namespace nixsource

src/nixsource.h

@@ -21,6 +21,8 @@ namespace nixsource {
 
     void sourcesFiltered(const extractor &input, infusor &output);
 
+    void findSources(const extractor &input, infusor &output);
+
 } // namespace nixsource
 
 #endif

tests/TestSource.m

@@ -27,6 +27,8 @@
     funcs{end+1} = @test_referring_multi_tags;
     funcs{end+1} = @test_compare;
     funcs{end+1} = @test_filter_source;
+    funcs{end+1} = @test_find_source;
+    funcs{end+1} = @test_find_source_filtered;
 end
 
 %% Test: fetch sources
@@ -369,3 +371,116 @@
     assert(size(filtered, 1) == 1);
     assert(strcmp(filtered{1}.name, mainName));
 end
+
+%% Test: Find source w/o filter
+function [] = test_find_source
+    f = nix.File(fullfile(pwd, 'tests', 'testRW.h5'), nix.FileMode.Overwrite);
+    b = f.create_block('testBlock', 'nixBlock');
+    s = b.create_source('mainSource', 'nixSource');
+    sl1 = s.create_source('sourceLvl1', 'nixSource');
+
+    sl21 = sl1.create_source('sourceLvl2_1', 'nixSource');
+    sl22 = sl1.create_source('sourceLvl2_2', 'nixSource');
+
+    sl31 = sl21.create_source('sourceLvl3_1', 'nixSource');
+    sl32 = sl21.create_source('sourceLvl3_2', 'nixSource');
+    sl33 = sl21.create_source('sourceLvl3_3', 'nixSource');
+
+    sl41 = sl31.create_source('sourceLvl4_1', 'nixSource');
+    sl42 = sl31.create_source('sourceLvl4_2', 'nixSource');
+    sl43 = sl31.create_source('sourceLvl4_3', 'nixSource');
+    sl44 = sl31.create_source('sourceLvl4_4', 'nixSource');
+
+    % Check invalid entry
+    err = 'Provide a valid search depth';
+    try
+        s.find_sources('hurra');
+    catch ME
+        assert(strcmp(ME.message, err));
+    end
+
+    % find all
+    filtered = s.find_sources(4);
+    assert(size(filtered, 1) == 11);
+
+    % find until level 3
+    filtered = s.find_sources(3);
+    assert(size(filtered, 1) == 7);
+
+    % find until level 2
+    filtered = s.find_sources(2);
+    assert(size(filtered, 1) == 4);
+
+    % find until level 1
+    filtered = s.find_sources(1);
+    assert(size(filtered, 1) == 2);
+
+    % find until level 0
+    filtered = s.find_sources(0);
+    assert(size(filtered, 1) == 1);
+end
+
+%% Test: Find sources with filters
+function [] = test_find_source_filtered
+    findSource = 'nixFindSource';
+    f = nix.File(fullfile(pwd, 'tests', 'testRW.h5'), nix.FileMode.Overwrite);
+    b = f.create_block('testBlock', 'nixBlock');
+    s = b.create_source('mainSource', 'nixSource');
+    sl1 = s.create_source('sourceLvl1', 'nixSource');
+
+    sl21 = sl1.create_source('sourceLvl2_1', 'nixSource');
+    sl22 = sl1.create_source('sourceLvl2_2', findSource);
+
+    sl31 = sl21.create_source('sourceLvl3_1', findSource);
+    sl32 = sl21.create_source('sourceLvl3_2', 'nixSource');
+    sl33 = sl21.create_source('sourceLvl3_3', 'nixSource');
+
+    sl41 = sl31.create_source('sourceLvl4_1', 'nixSource');
+    sl42 = sl31.create_source('sourceLvl4_2', 'nixSource');
+    sl43 = sl31.create_source('sourceLvl4_3', findSource);
+    sl44 = sl31.create_source('sourceLvl4_4', 'nixSource');
+
+    % test find by id
+    filtered = s.find_filtered_sources(0, nix.Filter.id, sl41.id);
+    assert(isempty(filtered));
+    filtered = s.find_filtered_sources(4, nix.Filter.id, sl41.id);
+    assert(size(filtered, 1) == 1);
+    assert(strcmp(filtered{1}.id, sl41.id));
+
+    % test find by ids
+    filterids = {sl1.id, sl41.id};
+    filtered = s.find_filtered_sources(1, nix.Filter.ids, filterids);
+    assert(size(filtered, 1) == 1);
+    filtered = s.find_filtered_sources(4, nix.Filter.ids, filterids);
+    assert(size(filtered, 1) == 2);
+
+    % test find by name
+    filtered = s.find_filtered_sources(0, nix.Filter.name, sl41.name);
+    assert(isempty(filtered));
+    filtered = s.find_filtered_sources(4, nix.Filter.name, sl41.name);
+    assert(size(filtered, 1) == 1);
+    assert(strcmp(filtered{1}.name, sl41.name));
+
+    % test find by type
+    filtered = s.find_filtered_sources(0, nix.Filter.type, findSource);
+    assert(isempty(filtered));
+    filtered = s.find_filtered_sources(4, nix.Filter.type, findSource);
+    assert(size(filtered, 1) == 3);
+    assert(strcmp(filtered{1}.type, findSource));
+
+    % test nix.Filter.metadata
+    sec = f.create_section('testSection', 'nixSection');
+    sl43.set_metadata(sec);
+    filtered = s.find_filtered_sources(0, nix.Filter.metadata, sec.id);
+    assert(isempty(filtered));
+    filtered = s.find_filtered_sources(4, nix.Filter.metadata, sec.id);
+    assert(size(filtered, 1) == 1);
+    strcmp(filtered{1}.id, sl43.id);
+
+    % test nix.Filter.source
+    filtered = s.find_filtered_sources(0, nix.Filter.source, sl44.id);
+    assert(isempty(filtered));
+    filtered = s.find_filtered_sources(4, nix.Filter.source, sl44.id);
+    assert(size(filtered, 1) == 1);
+    assert(strcmp(filtered{1}.id, sl31.id));
+end