1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/persistentdata/featuremgmt/featuremgr/tools/datfilehelpers/CreateFeatExample.pl	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,98 @@
     1.4 +#!perl -w
     1.5 +# Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +# All rights reserved.
     1.7 +# This component and the accompanying materials are made available
     1.8 +# under the terms of "Eclipse Public License v1.0"
     1.9 +# which accompanies this distribution, and is available
    1.10 +# at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +#
    1.12 +# Initial Contributors:
    1.13 +# Nokia Corporation - initial contribution.
    1.14 +#
    1.15 +# Contributors:
    1.16 +#
    1.17 +# Description:
    1.18 +# This simple script shows how simple it is to create a feature set data file
    1.19 +# using the 'FMCreate', 'FeatureFlag' and 'FeatureDSR' classes.
    1.20 +# 
    1.21 +#
    1.22 +
    1.23 +use strict;
    1.24 +use fmcreate;
    1.25 +use featureflag;
    1.26 +use featuredsr;
    1.27 +
    1.28 +#
    1.29 +# First create a 'FMCreate' object. Note that the typefield defaults to "feat",
    1.30 +# the fileversion defaults to '1', fileflags to '0'. Initially it contains no
    1.31 +# feature flags or default supported ranges.
    1.32 +#
    1.33 +my $fmc = FMCreate->new();
    1.34 +die "Couldn't create an 'FMCreate' object" unless(ref($fmc));
    1.35 +
    1.36 +#
    1.37 +# Now we can do all sorts of things with this object - for example populating
    1.38 +# it from an existing file (using the LoadUp method). But let's populate it
    1.39 +# manually..
    1.40 +#
    1.41 +
    1.42 +#
    1.43 +# Create a feature flag object. The arguments are UID, status flag (defaults
    1.44 +# to zero) and user data word. 
    1.45 +#
    1.46 +my $ff = FeatureFlag->new(0xabcd1234, undef, 0xf00df00d);
    1.47 +die "Couldn't create a 'FeatureFlag' object" unless(ref($ff));
    1.48 +
    1.49 +#
    1.50 +# Change some bits in the status flags.
    1.51 +#
    1.52 +$ff->Modifiable(1);
    1.53 +$ff->BlackListed(0);
    1.54 +$ff->Uninitialized(1);
    1.55 +
    1.56 +# Hey, I've decided I don't like the user data word (0xf00df00d) we defined
    1.57 +# when we created $ff, so lets change it..
    1.58 +$ff->UserData(0x12344331);
    1.59 +
    1.60 +# We need to add the feature flag to the 'FMCreate' object - they aren't tied
    1.61 +# in any way yet. 
    1.62 +$fmc->AddFeatureFlag($ff);
    1.63 +
    1.64 +# Create another FeatureFlag. We can't re-use the '$ff' object (without doing
    1.65 +# another 'new') because '$fmc' owns it now and holds a reference to it.
    1.66 +# This line creates a totally separate FeatureFlag object which we can set up
    1.67 +# in any way we like - but we must remember to add it to '$fmc'.
    1.68 +
    1.69 +$ff = FeatureFlag->new(0xfedcba98);
    1.70 +$fmc->AddFeatureFlag($ff);
    1.71 +
    1.72 +# Modify $ff - this is already in '$fmc' but that's ok - perhaps we want to
    1.73 +# modify one that's already in.
    1.74 +$ff->UserData(0x42);
    1.75 +$ff->BlackListed(1);
    1.76 +
    1.77 +
    1.78 +
    1.79 +# Ok now create a couple of 'default supported range' objects. Again we
    1.80 +# have to add these to the '$fmc' FMCreate object.
    1.81 +my $dsr1 = FeatureDSR->new(0x10000000, 0x10000005);
    1.82 +my $dsr2 = FeatureDSR->new(0x10000050, 0x10000055);
    1.83 +die "Failed to create 'FeatureDSR' object"  unless(ref($dsr1) and ref($dsr2));
    1.84 +
    1.85 +# Add them in the wrong order to '$fmc'. Note that 'FMCreate' does not check
    1.86 +# for duplicate default supported range objects (or FeatureFlag objects for
    1.87 +# that matter).
    1.88 +$fmc->AddFeatureDSR($dsr2);
    1.89 +$fmc->AddFeatureDSR($dsr1);
    1.90 +
    1.91 +
    1.92 +# OK, the FMCreate object '$fmc' is fairly well populated now. Lets display
    1.93 +# the content.. There also are methods to just show the header information, the
    1.94 +# FeatureFlag information and FeatureDSR information.
    1.95 +$fmc->ShowALL();
    1.96 +
    1.97 +
    1.98 +# Let's write the features to a binary file..
    1.99 +print "\n\n\nWriting feature set data to 'featureset.dat'\n";
   1.100 +$fmc->WriteToFile("featureset.dat")
   1.101 +	   	or die "Couldn't write to feature set data file 'featureset.dat'\n";