Skip to content

Commit

Permalink
fix pointable index for members and shapes
Browse files Browse the repository at this point in the history
  • Loading branch information
@jasdel
jasdel committed Nov 11, 2020
1 parent 4a12f5d commit 74ba1a8
Show file tree
Hide file tree
Showing 15 changed files with 952 additions and 550 deletions.
219 changes: 98 additions & 121 deletions codegen/smithy-go-codegen/src/main/java/software/amazon/smithy/go/codegen/CodegenUtils.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,14 @@
import software.amazon.smithy.codegen.core.CodegenException;
import software.amazon.smithy.codegen.core.Symbol;
import software.amazon.smithy.codegen.core.SymbolProvider;
import software.amazon.smithy.go.codegen.knowledge.GoPointableIndex;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.shapes.CollectionShape;
import software.amazon.smithy.model.shapes.MemberShape;
import software.amazon.smithy.model.shapes.ServiceShape;
import software.amazon.smithy.model.shapes.Shape;
import software.amazon.smithy.model.shapes.ShapeId;
import software.amazon.smithy.model.shapes.ShapeType;
import software.amazon.smithy.model.shapes.StructureShape;
import software.amazon.smithy.model.traits.EnumTrait;
import software.amazon.smithy.model.traits.RequiredTrait;
import software.amazon.smithy.model.traits.TitleTrait;
import software.amazon.smithy.utils.StringUtils;
Expand Down Expand Up @@ -146,26 +145,97 @@ public static String getSyntheticTypeNamespace() {
return CodegenUtils.SYNTHETIC_NAMESPACE;
}


/**
* Returns the operand decorated with an & if the address of the shape type can be taken.
*
* @param pointableIndex pointable index
* @param shape shape to use
* @param operand value to decorate
* @return updated operand
*/
public static String asAddressIfAddressable(GoPointableIndex pointableIndex, Shape shape, String operand) {
boolean shouldAddress = pointableIndex.isPointable(shape) && shape.getType() == ShapeType.STRUCTURE;
// TODO [denseListMap] is this supposed to be done for union members?
//if (context.getModel().expectShape(member.getContainer()).isUnionShape()) {
// Shape target = context.getModel().expectShape(member.getTarget());
// shouldDereference &= ProtocolUtils.usesScalarWhenUnionValue(target);
//}
return shouldAddress ? "&" + operand : operand;
}

/**
* Returns the operand decorated with an "*" if the shape is dereferencable.
*
* @param pointableIndex knowledge index for if shape is pointable.
* @param shape The shape whose value needs to be read.
* @param operand The value to be read from.
* @return updated operand
*/
public static String getAsValueIfDereferencable(
GoPointableIndex pointableIndex,
Shape shape,
String operand
) {
if (!pointableIndex.isDereferencable(shape)) {
return operand;
}

return '*' + operand;
}

/**
* Returns the operand decorated as a pointer type, without creating double pointer.
*
* @param pointableIndex knowledge index for if shape is pointable.
* @param shape The shape whose value of the type.
* @param operand The value to read.
* @return updated operand
*/
public static String getTypeAsTypePointer(
GoPointableIndex pointableIndex,
Shape shape,
String operand
) {
if (pointableIndex.isPointable(shape)) {
return operand;
}

return '*' + operand;
}

/**
* Get the pointer reference to operand , if symbol is pointable.
* This method can be used by deserializers to get pointer to
* operand.
*
* @param model model for api.
* @param writer The writer dependencies will be added to, if needed.
* @param pointableIndex knowledge index for if shape is pointable.
* @param shape The shape whose value needs to be assigned.
* @param operand The Operand is the value to be assigned to the symbol shape.
* @return The Operand, along with pointer reference if applicable
*/
public static String generatePointerValueIfPointable(GoWriter writer, Shape shape, String operand) {
public static String getAsPointerIfPointable(
Model model,
GoWriter writer,
GoPointableIndex pointableIndex,
Shape shape,
String operand
) {
if (!pointableIndex.isPointable(shape)) {
return operand;
}

if (shape.isMemberShape()) {
shape = model.expectShape(shape.asMemberShape().get().getTarget());
}

String prefix = "";
String suffix = ")";

switch (shape.getType()) {
case STRING:
if (shape.hasTrait(EnumTrait.class)) {
return operand;
}

prefix = "ptr.String(";
break;

Expand Down Expand Up @@ -198,126 +268,13 @@ public static String generatePointerValueIfPointable(GoWriter writer, Shape shap
break;

default:
if (isShapePassByReference(shape)) {
return '&' + operand;
}
return operand;
return '&' + operand;
}

writer.addUseImports(SmithyGoDependency.SMITHY_PTR);
return prefix + operand + suffix;
}

/**
* Gets a value version of the operate based on the shape type. Returns a string with dereferencing the provided
* operand value if needed. Shapes like Structure, maps, and slices are not dereferenced.
*
* @param writer The writer dependencies will be added to, if needed.
* @param shape The shape whose value needs to be assigned.
* @param operand The Operand is the value to be assigned to the symbol shape.
* @return The Operand, along with pointer reference if applicable
*/
public static String operandValueIfScalar(GoWriter writer, Shape shape, String operand) {
String prefix = "";
String suffix = ")";

switch (shape.getType()) {
case STRING:
if (shape.hasTrait(EnumTrait.class)) {
return operand;
}

prefix = "ptr.ToString(";
break;

case BOOLEAN:
prefix = "ptr.ToBool(";
break;

case BYTE:
prefix = "ptr.ToInt8(";
break;
case SHORT:
prefix = "ptr.ToInt16(";
break;
case INTEGER:
prefix = "ptr.ToInt32(";
break;
case LONG:
prefix = "ptr.ToInt64(";
break;

case FLOAT:
prefix = "ptr.ToFloat32(";
break;
case DOUBLE:
prefix = "ptr.ToFloat64(";
break;

case TIMESTAMP:
prefix = "ptr.ToTime(";
break;

default:
return operand;
}

writer.addUseImports(SmithyGoDependency.SMITHY_PTR);
return prefix + operand + suffix;
}

/**
* Returns whether the shape should be passed by value in Go.
*
* @param shape the shape
* @return whether the shape should be passed by value
*/
public static boolean isShapePassByValue(Shape shape) {
return shape.getType() == ShapeType.LIST
|| shape.getType() == ShapeType.SET
|| shape.getType() == ShapeType.UNION
|| shape.getType() == ShapeType.MAP
|| shape.getType() == ShapeType.BLOB
|| (shape.getType() == ShapeType.STRING && shape.hasTrait(EnumTrait.class));
}

/**
* Returns whether the shape should be passed by pointer reference in Go.
*
* @param shape the shape
* @return whether the shape should be passed by reference
*/
public static boolean isShapePassByReference(Shape shape) {
return !isShapePassByValue(shape);
}

/**
* Returns whether the provided shape can have a Go nil value assigned to it.
* If provided a MemberShape it will use the target shape and the aggregate shape containing
* the member is a reference frame to determine if nil is allowed.
*
* @param model the model
* @param shape the shape to test
* @return if the shape can be assigned a nil Go value
*/
public static boolean isNilAssignableToShape(Model model, Shape shape) {
if (shape instanceof MemberShape) {
ShapeId memberShapeId = shape.getId();

Shape aggregateShape = model.expectShape(ShapeId.fromParts(memberShapeId.getNamespace(),
memberShapeId.getName()));

// If the aggregate parent shape is not a structure the member shape is expected to not be a pointer
if (!(aggregateShape instanceof StructureShape)) {
return false;
}

shape = model.expectShape(((MemberShape) shape).getTarget());
}

return !shape.hasTrait(EnumTrait.class);
}

/**
* Returns the shape unpacked as a CollectionShape. Throws and exception if the passed in
* shape is not a list or set.
Expand Down Expand Up @@ -411,4 +368,24 @@ public static MemberShape expectMember(StructureShape shape, Predicate<String> m
public static String getServiceTitle(ServiceShape shape, String fallback) {
return shape.getTrait(TitleTrait.class).map(TitleTrait::getValue).orElse(fallback);
}

/**
* isNumber returns if the shape is a number shape.
*
* @param shape shape to check
* @return true if is a number shape.
*/
public static boolean isNumber(Shape shape) {
switch (shape.getType()) {
case BYTE:
case SHORT:
case INTEGER:
case LONG:
case FLOAT:
case DOUBLE:
return true;
default:
return false;
}
}
}
4 changes: 4 additions & 0 deletions ...gen/smithy-go-codegen/src/main/java/software/amazon/smithy/go/codegen/CodegenVisitor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@
import software.amazon.smithy.go.codegen.integration.GoIntegration;
import software.amazon.smithy.go.codegen.integration.ProtocolGenerator;
import software.amazon.smithy.go.codegen.integration.RuntimeClientPlugin;
import software.amazon.smithy.go.codegen.knowledge.GoPointableIndex;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.knowledge.NullableIndex;
import software.amazon.smithy.model.knowledge.ServiceIndex;
import software.amazon.smithy.model.knowledge.TopDownIndex;
import software.amazon.smithy.model.neighbor.Walker;
Expand Down Expand Up @@ -190,6 +192,8 @@ void execute() {
context.setSettings(settings);
context.setSymbolProvider(symbolProvider);
context.setDelegator(writers);
context.setPointableIndex(new GoPointableIndex(model));
context.setNullableIndex(new NullableIndex(model));

LOGGER.info("Generating serde for protocol " + protocolGenerator.getProtocol()
+ " on " + service.getId());
Expand Down
Loading

0 comments on commit 74ba1a8

Please sign in to comment.